2024年4月22日发(作者:)

项目文档命名规则

编 制: 日期:____/____/____

审 核: 日期:____/____/____

批 准: 日期:____/____/____

XXXX公司

二零一五年五月制

历史记录

01

02

章节名

说明

全文

修订

修订日

新建

章节

版本

修订人

发布日期

目 录

1 目的

本文的目的是定义各项目所有相关文档和CMM要求的过程文件的格式

和规则,以及配置管理中对配置项和版本的标识。

2 适用范围

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

3 术语和缩略词

4 规程

文档命名规则

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)

PIP(Project Investigate

2

产品调研计划

Plan)

产品

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

调研

(PI)

3

报告

OPA(Opponent Product

Difference Analyse

Report)

SMR(Standard Match

4

标准吻合度分析报告

Report)

PSR(Product System

5

产品系统需求

Requirement )

技术

1

预研

XX技术预研计划

TSP(Technology Study

Plan)

(TS)

2

XX技术预研报告

TSR(Technology Study

Report)

TFA(Technology

3

技术可行性分析报告

Feasibility Analyse

Report)

PSR(Product System

4

产品系统需求

Requirement )

SRS(Product Requirement

1

产品需求规格说明书

Specification)

PDP(Product Development

2

项目开发计划

Plan)

RMP(Risk Management

3

风险管理计划

Plan)

计划

4

与立

QAP(Quality Assurance

(PP)

CMP(Configuration

6

配置管理计划

Management Plan)

7

项目会议记录

meeting

PST(Product Schedule

8

产品工程计划与进度跟表

Trace)

9

产品界面原型设计

UID(User Interface

5

质量保证计划

Plan)

产品系统测试计划

PTP(Product Test Plan)

Design)

10

产品任务书

无需

PSA(Product Start

11

产品立项申请书

Apply)

PSD(Product System

1

设计

(DE)

2

3

XX模块概要设计说明书

XX模块详细设计说明书

产品总体设计说明书

Design)

HLD(High Level Design)

DD(Detail Design)

UTR(Product Unit Test

1

编码、

2

单元

ITC(Product Integerate

测试

(CUT)

ITP(Integerate Test

4

集成测试计划

Plan)

集成

1

测试

(IT)

增量

测试

和系

2

1

2

3

产品系统测试用例

测试入口检查单

系统测试方案

增量测试方案

产品集成测试报告

Report)

STC(System Test Case)

无需

STP(System Test Plan)

ATP(Alternate Test

ITR(Integerate Test

3

产品集成测试用例

Test Case)

用户手册

无需

产品单元测试汇总报告

Report)

统测

4

(ST)

5

4

Plan)

ATR(Alternate Test

增量测试报告

Report)

系统测试报告

STR(System Test Report)

文档版本

(1)

格式:V×××.×××,初始版本号为,最大版本号为:。其中,

草稿状态的版本均为V0.×××,例如:,……;而经过评审通过

的文档版本均从开始,例如:,,等。

5

密级程度

(1)

文档(包括电子文档和纸质文档)的密级分为三级,由低到高分别

是:公开级、限制级、核心级:

1)

公开级的文档使用的范围不受约束,例如研发人员,生产人员、

市场人员、行政人员和产品用户等;包括 用户手册、技术白皮

书、产品安装说明、宣传资料等。

2)

限制级的文档使用的范围仅限于研发内部的人员或生产人员;

包括 研发制度和规范、计划、产品需求、总体设计、模块设计、

详细设计、测试用例、测试报告、评审文档、生产资料等。

3)

核心级的文档使用的范围仅限于研发开发经理以上的人员。包

括 产品源码、产品镜像文件、公司或部门的敏感文件。

(2)

密级标注

密级在密级标识栏中填写,若无标识栏则在文档的右上角标注密

级。

6

文档编写格式

文档编写可以从研发模板库中取得相应模板进行编写,也可根据格式

要求进行编写,具体格式要求如下:

(1)

封面

1)

页眉、页脚空白

2)

封面上方文档编号表格

属性:文字环绕--无

置顶,上面无空行

中文宋体、英文Arial,全部加粗,宋体,号

3)

标题

2行:第一行:产品中文名称;第二行:文档名称

小一号字体,黑体,Arial,加粗

段前段后磅,单倍行距;无缩进,无悬挂

上方空2行,下方空3行

4)

签核栏位

四号字体,宋体,Arial,加粗

签核栏位4栏,到部门批准(研发副总);签核栏位5栏,

到批准(郭总)。具体的签核栏位数见《研发过程文档命名及签批

流程.xls》

左侧缩进4字符,右侧缩进字符,无悬挂;段前段后磅,

单倍行距

5)

模板制度日期

“XXXX公司”“二零XX年X月制”分两行;

小三号字体,黑体,Arial,加粗;居中

段前段后0行,单倍行距;无缩进,无悬挂

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

(2)

历史记录

1)

“历史记录”

小三,黑体,不加粗

段前段后0行,单倍行距

2)

表格

属性:文字环绕选无;行高,,最小;设置“在各页端以标

题行形式重复出现”

表头:五号,宋体,加粗,全部居中

格式:五号,宋体,Arial,不加粗,全部居中

内容:日期格式为,版本号

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

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行,倍行距。

(5)

表格

1)

表头:字体宋体,Arial,五号,加粗;上下居中,水平居中;

表格底纹设置为灰度25%

2)

内容:字体宋体,Arial,五号,不加粗

3)

行高:,最小值

4)

宽度:设置为页面宽度

(6)

流程图

均采用Visio 画图,底色均为默认的白色,图中字体均为宋体,

大小采用五号字体或10pt大小字体。

(7)

页边距:上下厘米,左右厘米

均采用Visio 画图,底色均为默认的白色,图中字体均为宋体,

大小采用五号字体或10pt大小字体。

配置项的版本标识

根据产品的需要,软件产品制造过程中的每个配置项和不同阶段的基

线发布都需要进行相应的版本标识,下面分别介绍。

1、配置项版本标识

对于文档、软件和硬件的版本号,项目过程中采用三位编码的原则,

格式如下:

,初始版本号为V1.0.0,最大版本号为:例如:V1.0.0;在个人工作

区如果对文档或编码进行修改,版本号的第三位迭代1,如V1.0.1。文档、

软件和硬件的各配置项的版本号第二位应统一。

从个人工作区提交到开发区时,由项目经理控制版本号的第二位的迭

代。建议:如果其中一项的特征进行了较大修改或者增加了新特性,第二

位迭代1,第三位恢复为0。如V1.1.0。

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

行一次变更版本号的第二位迭代1,并由SCM去掉版本号的第三位后放入基

线区。如:。

2、基线版本标识

SCM负责人负责把基线发布给外部客户(如发布运行基线)或内部使

用(如为测试而发布)。

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

,初始版本号为.,最大版本号为。

例如:;

标签的命名

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

标签的命名不可随意为之,要让标签名称具有很强的自说明性,并且

尽量不要过于复杂。标签命名分为以下两种情况:

a)

正是基线命名

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

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

发产品的版本,初始版本号为v1_0,最大版本号为v999_999;而“标签

版本号”指的是每次打标签递增的序号,范围从01到99。

b)

非正式基线或里程碑命名

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

类型_版本号_标签版本号,其中“类型”指的是alpha测试版、beta

测试版等,“版本号”指的是所开发产品的版本,初始版本号为v1_0,最

大版本号为v999_999;而“标签版本号”指的是每次打标签递增的序号,

范围从01到99。

注意:标签名称必须以字母开头,中间可以包含字母、数字、下划线

(_)和连字符(-),不能使用小数点。