【参考借鉴】项目文档命名规则及格式要求.doc

  • 格式:doc
  • 大小:108.50 KB
  • 文档页数:9

下载文档原格式

  / 9
  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

项目文档命名规则

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

RRRR公司

二零一五年五月制

历史记录

目录

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)过程文件格式:RRR-P-××,初始编号为:RRR-P-01,最大编号为:RRR-P-99。

(2)指南文件编号:RRR-G-××××,前两位××为指南所对应的过程文件编号。

(3)模板文件编号:RRR-T-××××,前两位××为指南所对应的过程文件编号。

2产品命名规范

(1)中文命名规范:中文全称V产品版本号。英文命名规范:首字母大写V产品版本号。3项目文档编号

(1)编号规则分三种:

1)单个文档:首字母大写V产品版本号-阶段英文缩写-文档名称英文缩写。

2)多个子文档:首字母大写V产品版本号-阶段英文缩写-文档名称英文缩写—流

水号。

3)周期性:首字母大写V产品版本号-文档名称/英文名称-八位日期。

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

(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行:第一行:产品中文名称VR.R;第二行:文档名称

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

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

✓上方空2行,下方空3行

4)签核栏位

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

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

具体的签核栏位数见《研发过程文档命名及签批流程.Rls》

✓左侧缩进4字符,右侧缩进-4.16字符,无悬挂;段前段后2.6磅,单倍行距

5)模板制度日期

✓“RRRR公司”“二零RR年R月制”分两行;

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

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

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

(2) 历史记录

1)“历史记录”

✓小三,黑体,不加粗

✓段前段后0行,单倍行距

2)表格

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

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

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

✓内容:日期格式为RRRR.mm.dd,版本号VR.R

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

3)页眉、页脚

✓页眉:

✓页脚:开始插入页码,页码格式为“第R页共R页”,小五号,宋体,Arial,居中

(3) 目录

2)“目录”

✓字体:小三,黑体,不加粗

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

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

3)目录内容

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

4)页眉、页脚

✓页眉:

✓页脚:插入页码,页码格式为“第R页共R页”,小五号,宋体,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厘米