软件测试文档编制规范.doc

文档编制规范. z.-目录文档编制规范1一、文档的分类2二、文档的编号2三、文档编写的格式要求33.1、页面布局33.1.1、页边距33.1.2、页眉页脚33.2、首页标题及公司基本信息43.3、目录43.4、正文43.4.1、正文内容43.4.2、小标题级别43.4.3、图片与表格53.4.4、功能点与列表83.5、8一、 文档的分类将文档分成如下几类：1、 规章制度类（GZZD）：公司、部门的各项规章制度；2、 工作规范类（GZGF）：各部门的工作规范；3、 项目管理规范类（*MGL）：项目管理规范、药监项目管理规范、招投标系统开发与实施指南等；4、 项目类文档（*M）：包括项目各个过程的产出物，如合同（HT）、建设方案（FA）、需求文档（*Q）、设计文档（SJ）、操作手册（CZSC）、测试报告（CSBG）等；5、 体系类（ISO9001、ISO27001、CMMI3）；6、 知识类（ZS）：各类技术经验总结等；7、 产品类（产品名称缩写）：如OA、Mis平台、电子招投标产品的介绍资料/操作手册等8、 其他类（不需要编号）：上述7个类别之外的其它文档。

二、 文档的编号文档的编号是文档唯一标识，主要用于文档的检索和版本控制文档编号规则如下：文档编号=文档所属部门代码+文档类别代码+文档流水号+版本号示例如下：所属部门代码文档类别文档流水号版本号备注开发1部（KF1）工作规范（GZGF）如001，002，010等V2.1KF1-GZGF-001 V2.1实施3部（SS3）项目（*M）项目活动名称首字母缩写+项目编号V1.0SS3-*M-*Q 2012060728V1.0测试部（CS）知识（ZS）如001，002，010等V1.0CS-ZS-001 V1.0　　例如：QYGL－ GZZD －001　V2.12．1表示第二版第一次修改第一个文件规章制度企业管理部说明：1. 部门代码为各部门的拼音首字母（公司的部门代码为GT*D）部门编码示例：企业管理部－QYGL、人力资源部－RLZY、行政部－*Z、开发部－KF（子部门为KF1、KF2类推）、实施部－SS（子部门SS1、SS3类推）、测试部－CS等；2. 版本号使用2位数字进行声明，数字间使用英文标点“.”隔开首位数字表示第几个版本，末尾数字表示版本内的第几次修改例如：v1.0表示第一次正式发布的版本；v1.2，表示在第一次发布后进行第二次修改后的文档。

3. 其它类的文档（各种表单、ppt等），无需编号、页眉页脚，如《培训记录表》等4. E*CEL类文档按WORD文档编号方式编号5. 其他各类外来文件，包括各法律法规、技术标准和顾客资料等，均按各自的原本编号，也不需要另外修改三、 文档编写的格式要求3.1、 页面布局3.1.1、 页边距上下页边距：2.54厘米，左右页边距：3.17厘米（默认）3.1.2、 页眉页脚页眉：加入公司logo图片左对齐；后面加上文档名称，用小五号宋体字（Times new Roman）；文件编号和版本号，如“GT*D-GZZD-001 V1.0”右对齐；页眉顶端距离0.8厘米页脚：加入公司名称及联系方式居中；加入页码/总页数右对齐页面底部；用小五号宋体字（Times new Roman），页脚底端距离1.2厘米首页如果是封页，则不显示页眉页脚3.2、 首页标题及公司基本信息公司基本信息：顶格、两端对齐，以图片形式放置公司logo及公司基本信息标题：用一号加粗黑体字（数字或英文字体用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、，……3.4.2.4、 第四级小四号宋体（Times new Roman），加粗，标准字符间距，两端对齐，大纲级别4级，1.5倍行距，段前段后6磅，左右无缩进，项目符号和1.1.1.1、，1.1.1.2、，……。

3.4.2.5、 第五级五号宋体（Times new Roman），加粗，标准字符间距，两端对齐，大纲级别4级，1.5倍行距，段前段后6磅，左右无缩进，项目符号和1.1.1.1.1、，1.1.1.1.2、，……3.4.2.6、 第六级五号宋体（Times new Roman），不加粗，标准字符间距，两端对齐，大纲级别4级，1.5倍行距，段前段后6磅，左右无缩进，项目符号和1.1.1.1.1.1、，1.1.1.1.1.2、，……3.4.3、 图片与表格3.4.3.1、 图片图片大于文档：将其缩小至左右两端与文档对齐，首行无缩进，大纲级别正文文本，1.5倍行距，左右无缩进，段前段后无间距，如下图所示：图片较小：图片居中对齐，首行无缩进，大纲级别正文文本，1.5倍行距，左右无缩进，段前段后无间距，如下图所示：3.4.3.2、 表格表格标题：五号宋体（Times new Roman），加粗，标准字符间距，水平居中对齐，使用底纹（如下表），跨页的表单需设置标题行重复无首行缩进，大纲级别正文文本，1.5倍行距，左右无缩进，段前段后无间距，其他保持标准表格内容：五号宋体（Times new Roman），不加粗，标准字符间距，根据内容选择水平左对齐或水平居中对齐，无首行缩进，大纲级别正文文本，1.5倍行距，左右无缩进，段前段后无间距，其他保持标准。

表格整体相对于文档，居中对齐如下表所示：项目阶段建设方输出文档承建方输出文档需求调研、分析《项目总体计划》《项目质量保证计划》《开工申请》《需求规格说明书》设计阶段《概要设计》《详细设计》《数据字典》编码、测试阶段《编码规范》《测试报告》(包括《测试用例》)《用户指南/帮助》《系统部署手册》《试运行计划》系统验收阶段培训与试运行《培训计划/方案》《培训资料》《试运行问题修复列表》终验《支付款意见》《验收计划/方案》《验收申请表》《支付款申请》项目整体管理《变更申请表》《项目周报》《变更申请表》《会议纪要》3.4.4、 功能点与列表3.4.4.1、 功能点五号宋体（Times new Roman），加粗，标准字符间距，左对齐，首行缩进2字符，大纲级别正文文本，1.5倍行距，左右无缩进，段前段后无间距，项目符号和●如下所示：l 功能点3.4.4.2、 列表五号宋体（Times new Roman），不加粗，标准字符间距，左对齐，首行缩进2字符，大纲级别正文文本，1.5倍行距，左右无缩进，段前段后无间距，项目符号和如下所示：ü 列表1ü 列表2ü 列表3ü 列表4ü 列表5ü 列表6如有，在正文下插入分页符，另起一页，首行缩进2字符，使用五号宋体字，加粗，标识“”两字，后标全角冒号和名称。

如有序号，使用阿拉伯数码，如：“：1.×××××”；名称后不加标点符号具体内容排版与正文一致1.×××××：2.×××××：3.×××××：4.×××××：5.×××××：6.×××××：7.×××××. z.。