技术文档编制管理规定

技术文档编制管理规定

1 范围

适用于公司各类技术文件编制与管理。

2 规范性引用文件

下列文件中的条款通过引用而成为本标准的条款。

GJB438B-2009 军用软件开发文档通用要求

QHG-QCX-4231-2016文件控制程序

3定义

本部分所指的产品仅指硬件产品和软件产品，当产品既有硬件又有软件时，硬件和软件的设计文件分别控制。

4 基本要求

5.1 编制要求

技术文件的编制要求主要有：

1)技术文档编制应正确、完整、协调、统一、字体、字号、格式等符合要求。

2)技术文档的层次划分和章、条、段、列项以及图、表、公式的编排方法按照本规定

执行。

3)技术文档中采用的名词、术语、符号和代号、计量单位等应全文一致，并符合国家

或军队现行有效的标准规定；必要时应在技术文档中给出定义或说明。

4)技术文档中正文字体、字号应一致，采用的字号、字体、行距及排列等应满足本规

定。

5.2页面设置

版面干净无底灰，自己清楚无断划，尺寸标准，版心不斜，版心尺寸为156mm*235mm。页面设置要求为：

1)上边距32±1mm，下边距30mm±1mm；

2)左边距28mm±1mm，右边距26mm±1mm；

3)Word文档格式中“段落”缩进和间距设置为0，对其方式选“两端对其”。

5 详细要求

5.1技术文档封面

每份技术文档都应有封面，封面内容包括份号、密级、项目名称、文档名称、文档编号、研制单位名称和编制日期，技术文档封面样式见附录1.

1)“份号：XXXX”（四号黑体），应位于封面版心左上方顶格标识，标识该份技术文

档的顺序号，顺序号应用三位阿拉伯数字表示。

2)“密级：XX”（四号黑体），应位于封面版心右上方顶格标识技术文档密级依据项目

签订密级确定，所有技术文档密级与所签项目密级保持一致。

3)“项目名称”（二号黑体），应位于份号下空三行（四号字，行间距设置为1.5倍行

距）居中位置，当技术文档内容较多时，可分册装订，并标识技术文档分册号，如

“（第一分册）”、“（第二分册）”。

4)“文档名称”（二号黑体）位于项目名称下方空三行（小四号字，行间距设置为1.5

倍行距）居中标识。

5)“文档代号”（二号黑体）位于文档名称下方空一行（小四号字，行间距设置为1.5

倍行距）居中标识。文档代码和配置项代码表示规则一致。

技术文件的代号一般情况由项目标识、文档标识和版本标识组成。其形式为：

--

版本标识

文件标识

项目标识

项目标识格式为：项目名称代码-子类代码（当存在子系统时使用子类代码）。项目名称应以软件任务书定义为准，项目名称代码-子类代码取用项目名称特征词组汉字的首字母组合或特征字符串。注意代码不能重复，且在一个项目中必须统一。代码举例见表.1。

表1 项目标识举例

常用文档标识代码表如下：

说明：软件文档标识代码可以根据实际需要自行添加，亦可修改上述代码。注意代码不能重复，且在一个项目中必须统一。

版本标识用于对版本加以区分、检索和跟踪，以表明各个版本之间的关系，版本号为数字结构，由以圆点相隔的四位阿拉伯数字组成。标识具体格式为：系统工程研制阶段（定型软件时适用）/技术状态.00.00，具体内容见表3“系统工程研制阶段标识”和表4“版本号表示”。随不同技术状态的版本变更，更新版本标识。

表3 系统工程研制阶段标识

表4 版本号表示

6)“单位名称”（三号宋体），应位于封面版心下方，编制日期之上居中标识（行间距

设置为1.5倍行距），以单位名称全称为准。

7)“编制日期”（三号宋体），应位于封面版心最下方居中标识，技术文件编制日期应

当用汉字书写，填至年、月，“零”统一用插入符号“○”表示，如“二○一六年

十二月”

5.2 内容的格式要求

每一份完整的技术文档应依次包括技术文档封面、辑要页、文档修改记录页、目次、正文，必要时还要包括附件等要素。

5.2.1辑要页

辑要页包括项目名称、文件名称、项目代号、总页数、完成单位、审批项、摘要七部分，以表格形式表述，具体形式见附录2。

1)“辑要页”（二号黑体）位于应位于版心正上方居中标识,两个字之间空两格(二号

黑体)。

2)“项目名称”（宋体小四），与封面项目名称一致。

3)“文件名称”（宋体小四），与封面文档名称一致。

4)“项目代号”（宋体小四），立项编号。

5)“总页数”（宋体小四）。

6)“完成单位”（宋体小四）。

7)“审批项”包括“编制、审核、标审、会签、批准”手写签署审批者姓名与日期，

日期书写形式“yyyymmdd”，如“20161227”。

8)“摘要”（宋体小四），概括文档主要内容。

5.2.2 文档修改记录

每次修改对修改版本号、修改内容、修改人、日期进行记录。修改信息用宋体五号字进行表示，具体形式见附录3。

5.2.3 目次

每份技术文件超过15也时应该编排目次，设置1.25倍行距，样式见附录4。目次（不是“目录”）也的编排要求为：

1)目次页置于文档修改也之后，“目次”二字之间空两字并位于版心正上方定格居中

排放，段前/段后设置为1.0行，用三号黑体。

2)目次中章、条编号位于版心左端定格对其（也可以分别按章、各层次条梯次缩进一

个字间距左对齐），章、条编号与标题之间空一字，条的编号一般不超过三级（即

二层次条），其标题与相应页码之间用“……”连接，页码不加编号，右端定格对

齐，段前/段后均设置为0行，用小四号宋体字。