项目文档命名规则及格式要求
- 格式:doc
- 大小:216.00 KB
- 文档页数:12
项目文档命名规则及格式要求
————————————————————————————————作者:————————————————————————————————日期:
项目文档命名规则
编制:日期:____/____/____审核:日期:____/____/____ 批准:日期:____/____/____
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(Project Investigate
Assignment)
2 产品调研计划PIP(Project Investigate Plan)
3 竞争对手产品对比差异分析报告
OPA(Opponent Product
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)
增量测试和系统测试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;第二行:文档名称