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

项目文档命名规则

编 制： 日期：

审 核： 日期：

批 准： 日期：

XXXX 公司

二零一五年五月制 XXXX 公司 命名规则

第 2 页 共 9 页

历史记录

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

01 全文 新建

1.0

02 修订 章节 4.1

1.1

XXXX 公司 命名规则

第 3 页 共 9 页

目录

1 目的 ......................................................................... 4

2 适用范围 ..................................................................... 4

3 术语和缩略词 ................................................................. 4

4 规程 ......................................................................... 4

4.1 文档命名规则 ........................................................... 4

4.2 配置项的版本标识 ....................................................... 8

4.3 标签的命名 ............................................................. 9XXXX 公司 命名规则

第 4 页 共 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(Project Investigate

Assignment)

2 产品调研计划 PIP(Project Investigate Plan) XXXX 公司 命名规则

第 5 页 共 9 页

3 竞争对手产品对比差异分析报告 OPA(Opponent Product XXXX 公司 命名规则

第 6 页 共 9 页

Difference Analyse Report)

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

5 产品系统需求 PSR(Product System Requirement )

技术预

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

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

3 技术可行性分析报告 TFA(Technology Feasibility Analyse

Report)

4 产品系统需求 PSR(Product System Requirement )

计划与 立项 (PP) 1 产品需求规格说明书 SRS(Product Requirement

Specification)

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

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

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

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

6 配置管理计划 CMP(Configuration Management

Plan)

7 项目会议记录 meeting

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

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

10 产品任务书 无需

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

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

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

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

编码、单

元测试

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

2 用户手册 无需

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

Case)

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)

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 等。 XXXX 公司 命名规则

第 7 页 共 9 页

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 行，单倍行距；无缩进，无悬挂 XXXX 公司 命名规则

第 8 页 共 9 页

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

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