文档编写规范参照.pdfVIP

密 级： 内部公开 版 本 号： V0.1 文档编写规范 测试部 文档编写规范 2016-9-26 文档修订记录 版本号 修订说明 修订人 修订日期 审核人 批准人 V0.1 创建 第 2 页 共 11 页 文档编写规范 2016-9-26 目 录 1. 文档目的 4 2. 适用范围 4 3. 正文规范 4 3.1. 规范总则 4 3.2. 产品说明书规范 4 3.2.1. 封面 4 3.2.2. 页面 6 3.2.3. 页眉页脚 6 3.2.4. 文档修订记录 6 3.2.5. 目录6 3.2.6. 标题 7 3.2.7. 正文 7 3.2.8. 表格 8 3.2.9. 图片 8 3.2.10. 注 8 3.3. 产品参数表文档 9 第 3 页 共 11 页 文档编写规范 2016-9-26 1. 文档目的 本文档用于规范文档编写工作，重在规范和统一文档风格。 2. 适用范围 本规范适用于测试部发布的产品文档，包括产品说明书、产品操作说明、产品参数表等用户文档。若 无特殊情况（如客户对文档有特定格式的要求） ，必须严格按照本规范要求进行编写。 3. 正文规范 3.1. 规范总则 1. 编写文档要使用统一的模板，切勿自行修改模块。 2. 文档中的语言要正式、规范、简洁明了，尽量避免使用口语化的语言。 3. 文档中尽可能避免使用错别字。现在常见错别字类型有使用简体字的繁体、输入法导致的笔误、易混 字的乱用等。 4. 文档描述系统功能一定要完整、详细、准确。 5. 文档维护过程中尽量前后统一。新增加部分的语言尽力向原有语言风格靠拢，避免前后相差太大给人 不规范的感觉。 6. 文档的维护要跟上系统维护的版本。系统升级新的版本后，相应的文档也要做更新。特别是系统做了 变更后，文档中所有涉及到的内容都要做更新。 7. 建议一篇文档中的字体颜色不要超过三种。 3.2. 产品说明书规范 3.2.1. 封面 1. 封页为文档的第一页，需包含公司 logo 、文档标题、公司名称等信息，示例图如下所示： 第 4 页 共 11 页 文档编写规范