2022年文档编写规范参照 .pdf
《2022年文档编写规范参照 .pdf》由会员分享,可在线阅读,更多相关《2022年文档编写规范参照 .pdf(11页珍藏版)》请在得力文库 - 分享文档赚钱的网站上搜索。
1、密级:内部公开版 本 号:V0.1文档编写规范测试部名师资料总结-精品资料欢迎下载-名师精心整理-第 1 页,共 11 页 -文档编写规范2016-9-26第 2 页 共 11 页文档修订记录版本号修订说明修订人修订日期审核人批准人V0.1创建名师资料总结-精品资料欢迎下载-名师精心整理-第 2 页,共 11 页 -文档编写规范2016-9-26第 3 页 共 11 页目录1.文档目的.42.适用范围.43.正文规范.43.1.规范总则.43.2.产品说明书规范.43.2.1.封面.43.2.2.页面.63.2.3.页眉页脚.63.2.4.文档修订记录.63.2.5.目录.63.2.6.标题.
2、73.2.7.正文.73.2.8.表格.83.2.9.图片.83.2.10.注.83.3.产品参数表文档.9名师资料总结-精品资料欢迎下载-名师精心整理-第 3 页,共 11 页 -文档编写规范2016-9-26第 4 页 共 11 页1.文档目的本文档用于规范文档编写工作,重在规范和统一文档风格。2.适用范围本规范适用于测试部发布的产品文档,包括产品说明书、产品操作说明、产品参数表等用户文档。若无特殊情况(如客户对文档有特定格式的要求),必须严格按照本规范要求进行编写。3.正文规范3.1.规范总则1.编写文档要使用统一的模板,切勿自行修改模块。2.文档中的语言要正式、规范、简洁明了,尽量避免
3、使用口语化的语言。3.文档中尽可能避免使用错别字。现在常见错别字类型有使用简体字的繁体、输入法导致的笔误、易混字的乱用等。4.文档描述系统功能一定要完整、详细、准确。5.文档维护过程中尽量前后统一。新增加部分的语言尽力向原有语言风格靠拢,避免前后相差太大给人不规范的感觉。6.文档的维护要跟上系统维护的版本。系统升级新的版本后,相应的文档也要做更新。特别是系统做了变更后,文档中所有涉及到的内容都要做更新。7.建议一篇文档中的字体颜色不要超过三种。3.2.产品说明书规范3.2.1.封面1.封页为文档的第一页,需包含公司logo、文档标题、公司名称等信息,示例图如下所示:名师资料总结-精品资料欢迎下
4、载-名师精心整理-第 4 页,共 11 页 -文档编写规范2016-9-26第 5 页 共 11 页2.封底为文档的最后一页,需包含公司地址、执行标准编号、公司网址等信息,示例图如下所示:名师资料总结-精品资料欢迎下载-名师精心整理-第 5 页,共 11 页 -文档编写规范2016-9-26第 6 页 共 11 页3.2.2.页面1.页面、版式原则上使用模版中的默认设置,纸张大小:A4,纸张方向:纵向。2.页边距:上下各2.54cm,左右各1.91cm,装订线0cm;距边界:页眉1.5cm,页脚 1.75cm。3.2.3.页眉页脚1.封面不显示页眉与页脚。2.页眉编辑格式:左边为文档名称,右边
5、为自动更新的日期(年-月-日):宋体(中文)/Times New Roman(英文和数字)、小五、居中。3.页脚编辑格式:页码从正文开始,按格式为:第1 页,共 x 页(宋体(中文)/Times New Roman(英文和数字)、小五、居中)连续编排。3.2.4.文档修订记录文档修订记录内容建议包括:版本号、修改日期、作者(修改人)、修订说明等,如下表所示,可以根据实际情况添加内容。修订页中的版本和作者要与封面的版本和编制一致。版本号修订说明修订人修订日期审核人批准人3.2.5.目录1.文档编写完成后都必须生成目录,目录一般显示到三级。2.“目录”两字:宋体、三号、加粗、居中对齐,且“目”与“
6、录”之间空两格。3.目录内容:宋体(中文)/Times New Roman(英文和数字)、五号、常规、两端对齐。4.一级目录左对齐不缩进,字体使用:宋体(中文)/Times New Roman(英文和数字)、五号;页码右对齐,标题与页码间使用“”连接;5.二级目录左对齐缩进2 个字符,字体使用:宋体(中文)/Times New Roman(英文和数字)、五号;页码右对齐,标题与页码间使用“”连接;名师资料总结-精品资料欢迎下载-名师精心整理-第 6 页,共 11 页 -文档编写规范2016-9-26第 7 页 共 11 页6.三级目录左对齐缩进4 个字符,字体使用:宋体(中文)/Times N
7、ew Roman(英文和数字)、五号;页码右对齐,标题与页码间使用“”连接。3.2.6.标题1.正文的章节标题须采用多级编号,且标题级数不要超过4 级,其格式如下所示:一级标题:1.标题 1二级标题:1.1.标题 2三级标题:1.1.1 标题 3四级标题:1.1.1.1 标题 42.标题 1:宋体(中文)/Times New Roman(英文和数字)、二号、加粗、左对齐;段前17 磅、段后 16.5磅、2.4 多倍行距、段前分页;标号与标题文字间制表位1.02 字符;标号选择样式:标题1。3.标题 2:黑体(中文)/Times New Roman(英文和数字)、三号、加粗、左对齐;段前段后各1
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 2022年文档编写规范参照 2022 文档 编写 规范 参照
限制150内