软件测试文档编制要求规范.docx

软件测试文档编制要求规范.docx

《软件测试文档编制要求规范.docx》由会员分享，可在线阅读，更多相关《软件测试文档编制要求规范.docx（8页珍藏版）》请在冰豆网上搜索。

软件测试文档编制要求规范

文档编制规

文档编制规1

一、文档的分类2

二、文档的编号2

三、文档编写的格式要求3

3.1、页面布局3

3.1.1、页边距3

3.1.2、页眉页脚3

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

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、规章制度类（编号：

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）

工作规（GZGF）

如001，002，010等

V2.1

KF1-GZGF-001V2.1

实施3部（SS3）

项目（XM）

项目活动名称首字母缩写+项目编号

V1.0

SS3-XM-XQ2012060728V1.0

测试部（CS）

知识（ZS）

如001，002，010等

V1.0

CS-ZS-001V1.0

　　例如：

QYGL－GZZD－001　V2.1

　　　　　　　　　　　　　　　　　　　2．1表示第二版第一次修改

　　　　　　　　　　　　　　　　　　　第一个文件

　　　　　　　　　　　　　　　　　　　规章制度

　　　　　　　　　　　　　　　　　　　企业管理部

说明：

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

部门编码示例：

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

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

首位数字表示第几个版本，末尾数字表示版本的第几次修改。

例如：

v1.0表示第一次正式发布的版本；v1.2，表示在第一次发布后进行第二次修改后的文档。

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

4.EXCEL类文档按WORD文档编号方式编号。

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

三、文档编写的格式要求

三.1、页面布局

三.1.1、页边距

上下页边距：

2.54厘米，左右页边距：

3.17厘米（默认）。

三.1.2、页眉页脚

页眉：

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

页脚：

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

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

三.2、首页标题及公司基本信息

公司基本信息：

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

标题：

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

三.3、目录

目录（二字）：

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

目录容：

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

在目录下方插入分页符。

三.4、正文

三.4.1、正文容

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

三.4.2、小标题级别

三.4.2.1、第一级

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

一、二、……。

三.4.2.2、第二级

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

1.1、，1.2、，……。

三.4.2.3、第三级

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

1.1.1、，1.1.2、，……。

三.4.2.4、第四级

小四号宋体（TimesnewRoman），加粗，标准字符间距，两端对齐，大纲级别4级，1.5倍行距，段前段后6磅，左右无缩进，项目符号和编号：

1.1.1.1、，1.1.1.2、，……。

三.4.2.5、第五级

五号宋体（TimesnewRoman），加粗，标准字符间距，两端对齐，大纲级别4级，1.5倍行距，段前段后6磅，左右无缩进，项目符号和编号：

1.1.1.1.1、，1.1.1.1.2、，……。

三.4.2.6、第六级

五号宋体（TimesnewRoman），不加粗，标准字符间距，两端对齐，大纲级别4级，1.5倍行距，段前段后6磅，左右无缩进，项目符号和编号：

1.1.1.1.1.1、，1.1.1.1.1.2、，……。

三.4.3、图片与表格

三.4.3.1、图片

图片大于文档：

将其缩小至左右两端与文档对齐，首行无缩进，大纲级别正文文本，1.5倍行距，左右无缩进，段前段后无间距，如下图所示：

图片较小：

图片居中对齐，首行无缩进，大纲级别正文文本，1.5倍行距，左右无缩进，段前段后无间距，如下图所示：

三.4.3.2、表格

表格标题：

五号宋体（TimesnewRoman），加粗，标准字符间距，水平居中对齐，使用底纹（如下表），跨页的表单需设置标题行重复。

无首行缩进，大纲级别正文文本，1.5倍行距，左右无缩进，段前段后无间距，其他保持标准。

表格容：

五号宋体（TimesnewRoman），不加粗，标准字符间距，根据容选择水平左对齐或水平居中对齐，无首行缩进，大纲级别正文文本，1.5倍行距，左右无缩进，段前段后无间距，其他保持标准。

表格整体相对于文档，居中对齐。

如下表所示：

项目阶段

建设方输出文档

承建方输出文档

需求调研、分析

《项目总体计划》

《项目质量保证计划》

《开工申请》

《需求规格说明书》

设计阶段

《概要设计》

《详细设计》

《数据字典》

编码、测试阶段

《编码规》

《测试报告》（包括《测试用例》）

《用户指南/帮助》

《系统部署手册》

《试运行计划》

系统验收阶段

培训

与试运行

《培训计划/方案》

《培训资料》

《试运行问题修复列表》

终验

《支付款意见》

《验收计划/方案》

《验收申请表》

《支付款申请》

项目整体管理

《变更申请表》

《项目周报》

《变更申请表》

《会议纪要》

三.4.4、功能点与列表

三.4.4.1、功能点

五号宋体（TimesnewRoman），加粗，标准字符间距，左对齐，首行缩进2字符，大纲级别正文文本，1.5倍行距，左右无缩进，段前段后无间距，项目符号和编号：

●。

如下所示：

●功能点

三.4.4.2、列表

五号宋体（TimesnewRoman），不加粗，标准字符间距，左对齐，首行缩进2字符，大纲级别正文文本，1.5倍行距，左右无缩进，段前段后无间距，项目符号和编号：

。

如下所示：

✓列表1

✓列表2

✓列表3

✓列表4

✓列表5

✓列表6

三.5、附件

如有附件，在正文下插入分页符，另起一页，首行缩进2字符，使用五号宋体字，加粗，标识“附件”两字，后标全角冒号和名称。

附件如有序号，使用阿拉伯数码，如：

“附件：

1.×××××”；附件名称后不加标点符号。

附件具体容排版与正文一致。

附件：

1.×××××

附件：

2.×××××

附件：

3.×××××

附件：

4.×××××

附件：

5.×××××

附件：

6.×××××

附件：

7.×××××