项目文档命名规则跟格式要求.docx

1、项目文档命名规则跟格式要求项目文档命名规则编 制： 日期：审 核： 日期：批 准： 日期：XXXX 公司二零一五年五月制历史记录编号章节名称说明修订日期版本号修订人发布日期01全文新建1.002修订章节 4.11.11目的 42适用范围 43术语和缩略词 44规程 44.1文档命名规则 44.2配置项的版本标识 84.3标签的命名 91 目的本文的目的是定义各项目所有相关文档和 CMM要求的过程文件的格式和规则， 以及配置管理中对配置项和版本的标识。2 适用范围本规则适用于所有需求、设计等文档和过程文件。3 术语和缩略词无4 规程4.1文档命名规则1 组织标准软件过程文档编号(1)过程文件格式

2、： XXX-P-，初始编号为： XXX-P-01，最大编号为： XXX-P-99 。(2)指南文件编号： XXX-G-，前两位为指南所对应的过程文件编号。(3)模板文件编号： XXX-T-，前两位为指南所对应的过程文件编号。2 产品命名规范(1)中文命名规范： 中文全称 V产品版本号。 英文命名规范： 首字母大写 V 产品版本号。 3 项目文档编号(1) 编号规则分三种：1)单个文档：首字母大写 V产品版本号 -阶段英文缩写 - 文档名称英文缩写。2)多个子文档： 首字母大写 V产品版本号 - 阶段英文缩写 -文档名称英文缩写流 水号。3)周期性：首字母大写 V产品版本号 - 文档名称 /英文

3、名称 - 八位日期。(2) 项目阶段及文档名称英文缩写，见下表：阶段序号文档名称英文及缩写产品调 研(PI)1产品调研任务书PIA(Project InvestigateAssignment)2产品调研计划PIP(Project Investigate Plan)3竞争对手产品对比差异分析报告OPA(Opponent ProductDifference Analyse Report)4标准吻合度分析报告SMR(Standard Match Report)5产品系统需求PSR(Product System Requirement )技术预 研(TS)1XX技术预研计划TSP(Technology

4、 Study Plan)2XX技术预研报告TSR(Technology Study Report)3技术可行性分析报告TFA(Technology Feasibility Analyse Report)4产品系统需求PSR(Product System Requirement )计划与 立项 (PP)1产品需求规格说明书SRS(Product RequirementSpecification)2项目开发计划PDP(Product Development Plan)3风险管理计划RMP(Risk Management Plan)4产品系统测试计划PTP(Product Test Plan)5质量

5、保证计划QAP(Quality Assurance Plan)6配置管理计划CMP(Configuration ManagementPlan)7项目会议记录meeting8产品工程计划与进度跟表PST(Product Schedule Trace)9产品界面原型设计UID(User Interface Design)10产品任务书无需11产品立项申请书PSA(Product Start Apply)设计 (DE)1产品总体设计说明书PSD(Product System Design)2XX模块概要设计说明书HLD(High Level Design)3XX模块详细设计说明书DD(Detail

6、Design)编码、单 元测试 (CUT)1产品单元测试汇总报告UTR(Product Unit Test Report)2用户手册无需3产品集成测试用例ITC(Product Integerate TestCase)4集成测试计划ITP(Integerate Test Plan)集成测 试(IT)1产品集成测试报告ITR(Integerate Test Report)2产品系统测试用例STC(System Test Case)增量测 试和系 统测试 (ST)1测试入口检查单无需2系统测试方案STP(System Test Plan)3增量测试方案ATP(Alternate Test Plan

7、)4增量测试报告ATR(Alternate Test Report)5系统测试报告STR(System Test Report)4 文档版本(1) 格式： V. ，初始版本号为 V0.1，最大版本号为： V999.999 。其中，草稿状态的版本均为 V0. ，例如： V0.1 ， V0.2 , V0.999 ；而经过评审通过 的文档版本均从 V1.0 开始，例如： V1.0，V1.1 ，V2.0 等。5密级程度(1) 文档(包括电子文档和纸质文档)的密级分为三级，由低到高分别是：公开级、限 制级、核心级：1)公开级的文档使用的范围不受约束， 例如研发人员，生产人员、市场人员、行 政人员和产品用

8、户等；包括 用户手册、技术白皮书、产品安装说明、宣传资 料等。2)限制级的文档使用的范围仅限于研发内部的人员或生产人员；包括 研发制度 和规范、计划、产品需求、总体设计、模块设计、详细设计、测试用例、测试 报告、评审文档、生产资料等。3)核心级的文档使用的范围仅限于研发开发经理以上的人员。包括 产品源码、 产品镜像文件、公司或部门的敏感文件。(2)密级标注 密级在密级标识栏中填写，若无标识栏则在文档的右上角标注密级。6文档编写格式 文档编写可以从研发模板库中取得相应模板进行编写， 也可根据格式要求进行编写， 具 体格式要求如下：(1) 封面1)页眉、页脚空白2)封面上方文档编号表格 属性：文字

9、环绕 -无 置顶，上面无空行 中文宋体、英文 Arial ，全部加粗，宋体， 10.5 号3)标题2 行：第一行：产品中文名称 Vx.x ；第二行：文档名称 小一号字体，黑体， Arial ，加粗段前段后 2.6 磅，单倍行距；无缩进，无悬挂 上方空 2 行，下方空 3 行4)签核栏位 四号字体，宋体， Arial ，加粗签核栏位 4 栏，到部门批准 (研发副总) ；签核栏位 5 栏，到批准 (郭总)。 具体的签核栏位数见研发过程文档命名及签批流程 .xls 左侧缩进 4 字符，右侧缩进 -4.16 字符，无悬挂；段前段后 2.6 磅，单倍 行距5)模板制度日期“XXXX 公司”“二零 XX

10、年 X 月制”分两行；小三号字体，黑体， Arial ，加粗；居中段前段后 0 行，单倍行距；无缩进，无悬挂下方插入分节符“下一页”(2) 历史记录1)“历史记录”小三，黑体，不加粗段前段后 0 行，单倍行距2)表格属性：文字环绕选无；行高， 0.6，最小；设置“在各页端以标题行形式 重复出现”表头：五号，宋体，加粗，全部居中格式：五号，宋体， Arial ，不加粗，全部居中内容：日期格式为 yyyy.mm.dd ，版本号 Vx.x表格下方插入分节符 -下一页3)页眉、页脚页眉：页脚：开始插入页码，页码格式为“第 X 页 共 X 页”，小五号，宋体， Arial ，居中(3)目录2) “目录”

11、字体：小三，黑体，不加粗“目录”两个字中间空 2 个字段前段后 0 行，多倍行距，设置选 33) 目录内容来自模板，显示级别 3 级，不加冒号4)页眉、页脚页眉：页脚：插入页码，页码格式为“第 X 页 共 X 页”，小五号，宋体， Arial ， 居中(4)正文1)标题： 字体均采用宋体加黑， 标题一为小三号字体， 标题二为四号， 依次类推。 段落为单倍行距。2)标题一段落段前 13 磅，段后 6 磅；标题二段落段前段后 6 磅；3)页眉页脚：页眉格式：左上角标注“西安交大公司网络科技有限公司” ，右上 角标注文档名称；页脚格式：第 页 共 页，封面不显示页码。4)内容：正文，字体，宋体， A

12、rial ，五号，不加粗，两端对齐，首行缩进 2 字 符，段后 0 行， 1.5倍行距。(5)表格1) 表头：字体宋体， Arial ，五号，加粗；上下居中，水平居中；表格底纹设置 为灰度 25%2)内容：字体宋体， Arial ，五号，不加粗3)行高：0.6cm，最小值4)宽度：设置为页面宽度(6) 流程图均采用 Visio 画图，底色均为默认的白色，图中字体均为宋体，大小采用五号字体 或 10pt 大小字体。(7) 页边距：上下 2.54 厘米，左右 3.17 厘米均采用 Visio 画图，底色均为默认的白色，图中字体均为宋体，大小采用五号字体 或 10pt 大小字体。4.2配置项的版本标

13、识根据产品的需要， 软件产品制造过程中的每个配置项和不同阶段的基线发布都需要进行 相应的版本标识，下面分别介绍。1、配置项版本标识对于文档、软件和硬件的版本号，项目过程中采用三位编码的原则，格式如下：Vxxx.xxx.xxxx ，初始版本号为 V1.0.0 ，最大版本号为： V999.999.9999.例如： V1.0.0 ；V82.456.15在个人工作区如果对文档或编码进行修改，版本号的第三位迭代 1，如 V1.0.1 。文档、软件和硬件的各配置项的版本号第二位应统一。从个人工作区提交到开发区时， 由项目经理控制版本号的第二位的迭代。 建议： 如果其 中一项的特征进行了较大修改或者增加了新

14、特性， 第二位迭代 1，第三位恢复为 0。如 V1.1.0 。从开发区提交到基线区时，由 SCCB控制版本号的第一位的迭代，进行一次变更版本号 的第二位迭代 1, 并由 SCM去掉版本号的第三位后放入基线区。如： V56.45 。2、基线版本标识SCM负责人负责把基线发布给外部客户（如发布运行基线）或内部使用（如为测试而发 布）。基线的版本号采用两位编号原则，格式如下：Vxxx.xxx, 初始版本号为 V1.0. ，最大版本号为 V999.999 。例如： V1.0 ； V33.994.3标签的命名SCM 人员负责对开发过程中的重要里程碑及基线进行标签的标注。 标签的命名不可随意为之，要让标签

15、名称具有很强的自说明性，并且尽量不要过于复 杂。标签命名分为以下两种情况：a） 正是基线命名 标签名称必须以该项目组产品名称的英文字母开头，格式如下： 产品英文名称 _版本号 _REL+ 标签版本号，其中“版本号”指的是所开发产品的版本， 初始版本号为 v1_0，最大版本号为 v999_999 ；而“标签版本号”指的是每次打标签递增的 序号，范围从 01 到 99。b） 非正式基线或里程碑命名标签名称以类型的英文字母开头，格式如下：类型_版本号_标签版本号，其中“类型”指的是 alpha测试版、 beta测试版等，“版本号”指的是所开发产品的版本，初始版本号为 v1_0，最大版本号为 v999_999 ；而“标签版本号”指的是每次打标签递增的序号，范围从 01到 99。注意： 标签名称必须以字母开头，中间可以包含字母、数字、下划线（ _）和连字符（），不能使用小数点。