(完整word版)项目文档命名规则与格式要求(word文档良心出品).doc

.

项目文档命名规则

编制：日期： ____/____/____ 审核：日期： ____/____/____ 批准：日期： ____/____/____

.

XXXX公司二零一五年五月制

.

历史记录

编号章节名称说明修订日期版本号修订人发布日期

01 全文新建 1.0

02 修订章节 4.1 1.1

.

目录

1 目的 (5)

2 适用范围 (5)

3 术语和缩略词 (5)

4 规程 (5)

4.1 文档命名规则 (5)

4.2 配置项的版本标识 (12)

4.3 标签的命名 (13)

1目的

本文的目的是定义各项目所有相关文档和CMM 要求的过程文件的格式和规则，以及配置管理中对配置项和版本的标识。

2适用范围

本规则适用于所有需求、设计等文档和过程文件。

3术语和缩略词

无

4规程

4.1 文档命名规则

1组织标准软件过程文档编号

(1)过程文件格式： 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 产品版本号 -文档名称 /英文名称 -八位日期。

(2)项目阶段及文档名称英文缩写，见下表：

阶段序号文档名称英文及缩写

PIA(Project Investigate

1 产品调研任务书

Assignment)

2 产品调研计划PIP(Project Investigate Plan)

产品调OPA(Opponent Product

3 竞争对手产品对比差异分析报告

研 (PI) Difference Analyse Report)

4 标准吻合度分析报告SMR(Standard Match Report)

PSR(Product System

5 产品系统需求

Requirement )

1 XX 技术预研计划TSP(Technology Study Plan)

2 XX 技术预研报告TSR(Technology Study Report)

技术预TFA(Technology Feasibility

3 技术可行性分析报告

研 (TS) Analyse Report)

PSR(Product System

4 产品系统需求

Requirement )

计划与SRS(Product Requirement

1 产品需求规格说明书

立项Specification) (PP)2项目开发计划PDP(Product Development Plan)

设计(DE)

编码、单元测试(CUT)

集成测试(IT)增量测

.

3 风险管理计划RMP(Risk Management Plan)

4 产品系统测试计划PTP(Product Test Plan)

5 质量保证计划QAP(Quality Assurance Plan)

CMP(Configuration Management 6 配置管理计划

Plan)

7 项目会议记录meeting

8 产品工程计划与进度跟表PST(Product Schedule Trace)

9 产品界面原型设计UID(User Interface Design)

10 产品任务书无需

11 产品立项申请书PSA(Product Start Apply)

1 产品总体设计说明书PSD(Product System Design)

2 XX 模块概要设计说明书HLD(High Level Design)

3 XX 模块详细设计说明书DD(Detail Design)

1 产品单元测试汇总报告UTR(Product Unit Test Report)

2 用户手册无需

ITC(Product Integerate Test 3 产品集成测试用例

Case)

4 集成测试计划ITP(Integerate Test Plan)

1 产品集成测试报告ITR(Integerate Test Report)

2 产品系统测试用例STC(System Test Case)

1 测试入口检查单无需

.

试和系 2 系统测试方案STP(System Test Plan)

统测试 3 增量测试方案ATP(Alternate Test Plan) (ST) 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)公开的文档使用的范不受束，例如研人，生人、市人、行

政人和品用等；包括用手册、技白皮、品安装明、宣料等。

2)限制的文档使用的范限于研内部的人或生人；包括研制度

和范、划、品需求、体、模、、用例、

告、文档、生料等。

3)核心的文档使用的范限于研开理以上的人。包括品源、

品像文件、公司或部的敏感文件。

(2)密注

密在密中填写，若无在文档的右上角注密。

6文档写格式

文档编写可以从研发模板库中取得相应模板进行编写，也可根据格式要求进行编写，具体格式要求如下：

(1)封面

1)页眉、页脚空白

2)封面上方文档编号表格属

性：文字环绕 --无

置顶，上面无空行

中文宋体、英文 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 年 X 月制”分两行；

小三号字体，黑体，Arial ，加粗；居中

段前段后 0 行，单倍行距；无缩进，无悬挂

下方插入分节符“下一页”

(2)历史记录

1)“历史记录”

小三，黑体，不加粗

段前段后 0 行，单倍行距

2)表格

属性：文字环绕选无；行高，0.6 ，最小；设置“在各页端以标题行形式重复出现”

表头：五号，宋体，加粗，全部居中

格式：五号，宋体，Arial ，不加粗，全部居中

内容：日期格式为yyyy.mm.dd ，版本号Vx.x

表格下方插入分节符-下一页

3)页眉、页脚

页眉：

页脚：开始插入页码，页码格式为“第 X 页共 X 页”，小五号，宋体，Arial ，居中

(3)目录

2)“目录”

字体：小三，黑体，不加粗

“目录”两个字中间空2 个字

段前段后 0 行，多倍行距，设置选 3

3)目录内容

来自模板，显示级别 3 级，不加冒号

4)页眉、页脚

页眉：

页脚：插入页码，页码格式为“第X 页共 X 页”，小五号，宋体，Arial ，居中

(4)正文

1)标题：字体均采用宋体加黑，标题一为小三号字体，标题二为四号，依次类推。段落为单倍行距。

2) 标题一段落段前 13 磅，段后 6 磅；标题二段落段前段后 6 磅；

3) 页眉页脚：页眉格式：左上角标注“西安交大公司网络科技有限公司”，右上角标注文档名称；页脚格式：第×页共×页，封面不显示页码。

4) 内容：正文，字体，宋体，Arial ，五号，不加粗，两端对齐，首行缩进 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 配置项的版本标识

根据产品的需要，软件产品制造过程中的每个配置项和不同阶段的基线发布都需要进行

相应的版本标识，下面分别介绍。

1、配置项版本标识

.

对于文档、软件和硬件的版本号，项目过程中采用三位编码的原则，格式如下：

Vxxx.xxx.xxxx，初始版本号为V1.0.0 ，最大版本号为：V999.999.9999.

例如： V1.0.0 ； V82.456.15

在个人工作区如果对文档或编码进行修改，版本号的第三位迭代 1 ，如 V1.0.1 。文档、软件和硬件的各配置项的版本号第二位应统一。

从个人工作区提交到开发区时，由项目经理控制版本号的第二位的迭代。建议：如果其中一项的特征进行了较大修改或者增加了新特性，第二位迭代 1 ，第三位恢复为0 。如 V1.1.0 。

从开发区提交到基线区时，由SCCB控制版本号的第一位的迭代，进行一次变更版本

号的第二位迭代1,并由 SCM 去掉版本号的第三位后放入基线区。如：V56.45 。

2、基线版本标识

SCM 负责人负责把基线发布给外部客户（如发布运行基线）或内部使用（如为测试而

发布）。

基线的版本号采用两位编号原则，格式如下：

Vxxx.xxx, 初始版本号为V1.0. ，最大版本号为V999.999 。

例如： V1.0 ； V33.99

4.3 标签的命名

SCM 人员负责对开发过程中的重要里程碑及基线进行标签的标注。

标签的命名不可随意为之，要让标签名称具有很强的自说明性，并且尽量不要过于复

杂。标签命名分为以下两种情况：

a)正是基线命名

标签名称必须以该项目组产品名称的英文字母开头，格式如下：

产品英文名称_版本号 _REL+ 标签版本号，其中“版本号”指的是所开发产品的版本，初

.

始版本号为v1_0 ，最大版本号为v999_999 ；而“标签版本号”指的是每次打标签递增的序号，

范围从 01 到 99 。

b)非正式基线或里程碑命名

标签名称以类型的英文字母开头，格式如下：

类型 _版本号 _标签版本号，其中“类型”指的是 alpha 测试版、 beta 测试版等，“版本号”指的是所开发产品的版本，初始版本号为v1_0 ，最大版本号为v999_999 ；而“标签版本号”指的是每次打标签递增的序号，范围从01 到 99。

注意：标签名称必须以字母开头，中间可以包含字母、数字、下划线（_）和连字符（－），不能使用小数点。