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

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

《项目文档命名规则跟格式要求.docx》由会员分享，可在线阅读，更多相关《项目文档命名规则跟格式要求.docx（10页珍藏版）》请在冰点文库上搜索。

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

项目文档命名规则

编制：

日期：

审核：

日期：

批准：

日期：

XXXX公司

二零一五年五月制

历史记录

编号

章节名称

说明

修订日期

版本号

修订人

发布日期

01

全文

新建

1.0

02

修订

章节4.1

1.1

1目的4

2适用范围4

3术语和缩略词4

4规程4

4.1文档命名规则4

4.2配置项的版本标识8

4.3标签的命名9

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）项目阶段及文档名称英文缩写，见下表：

阶段

序号

文档名称

英文及缩写

产品调研（PI）

1

产品调研任务书

PIA（ProjectInvestigate

Assignment）

2

产品调研计划

PIP（ProjectInvestigatePlan）

3

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

OPA（OpponentProduct

DifferenceAnalyseReport）

4

标准吻合度分析报告

SMR（StandardMatchReport）

5

产品系统需求

PSR（ProductSystemRequirement）

技术预研（TS）

1

XX技术预研计划

TSP（TechnologyStudyPlan）

2

XX技术预研报告

TSR（TechnologyStudyReport）

3

技术可行性分析报告

TFA（TechnologyFeasibilityAnalyseReport）

4

产品系统需求

PSR（ProductSystemRequirement）

计划与立项（PP）

1

产品需求规格说明书

SRS（ProductRequirement

Specification）

2

项目开发计划

PDP（ProductDevelopmentPlan）

3

风险管理计划

RMP（RiskManagementPlan）

4

产品系统测试计划

PTP（ProductTestPlan）

5

质量保证计划

QAP（QualityAssurancePlan）

6

配置管理计划

CMP（ConfigurationManagement

Plan）

7

项目会议记录

meeting

8

产品工程计划与进度跟表

PST（ProductScheduleTrace）

9

产品界面原型设计

UID（UserInterfaceDesign）

10

产品任务书

无需

11

产品立项申请书

PSA（ProductStartApply）

设计（DE）

1

产品总体设计说明书

PSD（ProductSystemDesign）

2

XX模块概要设计说明书

HLD（HighLevelDesign）

3

XX模块详细设计说明书

DD（DetailDesign）

编码、单元测试（CUT）

1

产品单元测试汇总报告

UTR（ProductUnitTestReport）

2

用户手册

无需

3

产品集成测试用例

ITC（ProductIntegerateTest

Case）

4

集成测试计划

ITP（IntegerateTestPlan）

集成测试（IT）

1

产品集成测试报告

ITR（IntegerateTestReport）

2

产品系统测试用例

STC（SystemTestCase）

增量测试和系统测试（ST）

1

测试入口检查单

无需

2

系统测试方案

STP（SystemTestPlan）

3

增量测试方案

ATP（AlternateTestPlan）

4

增量测试报告

ATR（AlternateTestReport）

5

系统测试报告

STR（SystemTestReport）

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。

注意：

标签名称必须以字母开头，中间可以包含字母、数字、下划线（_）和连字符

（－），不能使用小数点。