软件测试文档编制规范

文档编制规范

文档编制规范 GTXD-GZZD-008 V1.0

目录

文档编制规范 ................................................................................................................................... 1 一、 文档的分类 ....................................................................................................................... 2 二、 文档的编号 ....................................................................................................................... 2 三、 文档编写的格式要求 ....................................................................................................... 3

3.1、 页面布局 ................................................................................................................... 3

3.1.1、 页边距 ............................................................................................................... 3 3.1.2、 页眉页脚 ........................................................................................................... 3 3.2、 首页标题及公司基本信息 ....................................................................................... 3 3.3、 目录 ........................................................................................................................... 4 3.4、 正文 ........................................................................................................................... 4

3.4.1、 正文内容 ........................................................................................................... 4 3.4.2、 小标题级别 ....................................................................................................... 4 3.4.3、 图片与表格 ....................................................................................................... 5 3.4.4、 功能点与列表 ................................................................................................... 8 3.5、 附件 ........................................................................................................................... 8

1/10

文档编制规范 GTXD-GZZD-008 V1.0

一、 文档的分类

将文档分成如下几类：

1、 规章制度类（编号：GZZD）：公司、部门的各项规章制度； 2、 工作规范类（编号：GZGF）：各部门的工作规范；

3、 项目管理规范类（编号：XMGL）：项目管理规范、药监项目管理规范、招投标系统开

发与实施指南等；

4、 项目类文档（编号：XM）：包括项目各个过程的产出物，如合同（HT）、建设方案（FA）、

需求文档（XQ）、设计文档（SJ）、操作手册（CZSC）、测试报告（CSBG）等； 5、 体系类（ISO9001、ISO27001、CMMI3）； 6、 知识类（编号：ZS）：各类技术经验总结等；

7、 产品类（编号：产品名称缩写）：如OA、Mis平台、电子招投标产品的介绍资料/操作手

册等

8、 其他类（不需要编号）：上述7个类别之外的其它文档。

二、 文档的编号

文档的编号是文档唯一标识，主要用于文档的检索和版本控制。 文档编号规则如下：

文档编号=文档所属部门代码+文档类别代码+文档流水号+版本号 示例如下：

所属部门代码 开发1部（KF1） 实施3部（SS3） 测试部（CS） 文档类别 工作规范（GZGF） 项目（XM） 知识（ZS） 文档流水号 如001，002，010等 项目活动名称首字母缩写+项目编号 如001，002，010等 版本号 V2.1 V1.0 V1.0 备注 KF1-GZGF-001 V2.1 SS3-XM-XQ 2012060728V1.0 CS-ZS-001 V1.0

例如：QYGL－ GZZD －001 V2.1

2．1表示第二版第一次修改 第一个文件 规章制度 2/10

文档编制规范 GTXD-GZZD-008 V1.0

企业管理部 说明：

1. 部门代码为各部门的拼音首字母（公司的部门代码为GTXD）。

部门编码示例：

企业管理部－QYGL、人力资源部－RLZY、行政部－XZ、开发部－KF（子部门为KF1、KF2类推）、实施部－SS（子部门SS1、SS3类推）、测试部－CS等；

2. 版本号使用2位数字进行声明，数字间使用英文标点“.”隔开。首位数字表示第几个

版本，末尾数字表示版本内的第几次修改。例如：v1.0表示第一次正式发布的版本；v1.2，表示在第一次发布后进行第二次修改后的文档。

3. 其它类的文档（各种表单、ppt等），无需编号、页眉页脚，如《培训记录表》等。 4. EXCEL类文档按WORD文档编号方式编号。

5. 其他各类外来文件，包括各法律法规、技术标准和顾客资料等，均按各自的原本编号，

也不需要另外修改。

三、 文档编写的格式要求

3.1、 页面布局

3.1.1、

页边距

上下页边距：2.54厘米，左右页边距：3.17厘米（默认）。

3.1.2、 页眉页脚

页眉：加入公司logo图片左对齐；后面加上文档名称，用小五号宋体字（Times new Roman）；文件编号和版本号，如“GTXD-GZZD-001 V1.0”右对齐；页眉顶端距离0.8厘米。

页脚：加入公司名称及联系方式居中；加入页码/总页数右对齐页面底部；用小五号宋体字（Times new Roman），页脚底端距离1.2厘米。

首页如果是封页，则不显示页眉页脚。

3.2、 首页标题及公司基本信息

公司基本信息：顶格、两端对齐，以图片形式放置公司logo及公司基本信息。

3/10

文档编制规范 GTXD-GZZD-008 V1.0

标题：用一号加粗黑体字（数字或英文字体用Times new Roman），可分一行或多行居中对齐，4倍行距，正文文本，分行时，要做到词意完整，排列对称，间距恰当。

3.3、 目录

目录（二字）：三号加粗宋体字，字符间距10磅，居中对齐，1.5倍行距，大纲级别正文文本，左右无缩进，段前段后无间距。

目录内容：五号宋体（Times new Roman），单倍行距，不加粗，不倾斜，采用“引用自动目录”方式获取目录。

在目录下方插入分页符。

3.4、 正文

3.4.1、

正文内容

五号宋体（Times new Roman），不加粗，标准字符间距，左对齐，首行缩进2字符，1.5倍行距，左右无缩进，段前段后无间距，其他保持标准。

3.4.2、 小标题级别

3.4.2.1、 第一级

三号宋体，加粗，标准字符间距，两端对齐，大纲级别1级，1.5倍行距，段前段后6磅，左右无缩进，项目符号和编号：一、二、??。

3.4.2.2、 第二级

小三号宋体（Times new Roman），加粗，标准字符间距，两端对齐，大纲级别2级，1.5倍行距，段前段后6磅，左右无缩进，项目符号和编号：1.1、，1.2、，??。

3.4.2.3、 第三级

四号宋体（Times new Roman），加粗，标准字符间距，两端对齐，大纲级别3级，1.5倍行距，段前段后6磅，左右无缩进，项目符号和编号：1.1.1、，1.1.2、，??。

4/10