09文档编写规范(doc)
目录 1、 目的 2 2、 范围 2 3、 文档首页(封面) 2 4、 页眉与页脚 3 5、 文档控制和签字确认 4 6、 目录 4 7、 正文（含附录） 4 8、 过程文件中各项内容编排的一般顺序 4 目的 为编写各类技术文档提供指导，以达到整齐、风格统一的效果，对文档的格式、命名 、版面、文字等进行了规范，以供参考。 范围 适合于Microsoft Word类文档，但编号规则适用于全部项目和模版文档。 文档首页(封面) 公司徽记[图标，居左上角] 文档名称[黑体，二号，加粗，居中] 文档编号[宋体，四号，居中] 版本号[宋体，四号，居中] 作者：[宋体，四号，居中] 年 月 日[宋体，四号，居中] 公司名称[宋体，四号，居中] o 命名规则：当前版本没有设置专门的规则，只是用中文命名，这个文件名表达了编 写该文档的意图，后缀为相应文档编辑软件的扩展名。 o 编号规则：Q/RKS --- 公司代码 英文缩写 1）SP 软件过程模板类 2）YYXXX 项目工作产品类 YYXXX表示项目代码，五位：YY：为年号 XXX：为序号 文档类别，英文缩写。 例子： GNR 通用类文档 RM 需求类文档（包括验收计划） SPP 项目计划类文档（包括各种测试计划） SPT 计划跟踪和监控类文档 SQA 质量保证类文档 SCM 配置管理类文档 PR 评审类文档 COM 沟通类文档 DES 设计类文档 TRN 培训类文档 EST 项目估算类文档 TEC 技术标准类文档 DEV 开发规范类文档 MTN 维护类文档 DB 数据库DDL脚本类文档 QC 测试类文档 文件按时间产生的顺序号，范围01-99。 例子： Q/RKS-SP-GNR -09 -> 文档书写规范 o 版本编号：初始的版本号为1.0，为适应某一方面的要求进行的升级为点版本升级， 如1.1、1.2等，全面的设计更改或大的变更，升级为2.0、3.0等。 说明：在项目中使用各种模版时，模版中出现的软件过程模版类编号一律改为项 目工作产品类编号，如软件需求说明书页脚的Q/RKS-SP-RM-05改为Q/RKS-YYXXX- RM-SNO。 页眉与页脚 (1)、原则：页面属性[版式]配置为首页不同，即首页之后的页面均采用本节规定的格式 ，[文档网格]配置为无网格。 (2)、页眉： 文档名称 [宋体，五，左齐] 版本号：[宋体，五，居中] 公司徽记[图标，右齐] 自动加下划线 例子： 软件需求说明书 版本号：1.0 [pic] (3)、页脚： 文档ID[宋体，小五，左齐]年 月 日[宋体，小五，居中]Page of [宋体，小五，右齐] 例子： Q/RKS-SP-RM-05 2001年8月15号 Page 1 of 5 说明：在项目使用时，其中版本号为项目文档的版本号，日期为项目文档的编写时间。 文档控制和签字确认 有首页(封面)的放在第二页，即目录页前一页；无封面放在最后一节。 例子： 文档修订 |版本 |日期 |修改人 |描述（注明修改的条款或页） | | | | | | | | | | | | | | | | 批准人签字 |职务 |甲方/乙方 |姓名 |日期 | | | | | | | | | | | 目录 比较大的文档可设置目录页，配置为显示页码和页码右对齐，直接插入即可，单独成 为一页。此页加正文“目录” [黑体，二号，加粗，居中]。显示级别为3，格式选模板中“正式”，字体四号。 正文（含附录） 字体：中文宋体小四，不加粗； 标题1：黑体，三号，加粗(Microsoft word2000缺省)；如:“1.” 标题2：黑体，四号，加粗(Microsoft word2000缺省); 如:“1.1” 标题3：黑体，小四号，加粗(Microsoft word2000缺省), 如:“1.1.1” 编号控制在4级之内。 行间距：单倍行间距。 段落出现两行以上的首行缩进二个汉字，段落间可加一空行。 过程文件中各项内容编排的一般顺序 1. 目的 2. 范围 3. 职责 4. 工作程序 5. 参考资料
09文档编写规范(doc)