技术文档编制管理规定.docxVIP

技术文档编制管理规定 C/0 Q/HG-QZY-8211-2016 PAGE3 / NUMPAGES14 技术文档编制管理规定 1 范围 适用于公司各类技术文件编制与管理。 2 规范性引用文件 下列文件中的条款通过引用而成为本标准的条款。 GJB438B-2009 军用软件开发文档通用要求 QHG-QCX-4231-2016文件控制程序 3定义 本部分所指的产品仅指硬件产品和软件产品，当产品既有硬件又有软件时，硬件和软件的设计文件分别控制。 4 基本要求 5.1 编制要求 技术文件的编制要求主要有： 技术文档编制应正确、完整、协调、统一、字体、字号、格式等符合要求。 技术文档的层次划分和章、条、段、列项以及图、表、公式的编排方法按照本规定执行。 技术文档中采用的名词、术语、符号和代号、计量单位等应全文一致，并符合国家或军队现行有效的标准规定；必要时应在技术文档中给出定义或说明。 技术文档中正文字体、字号应一致，采用的字号、字体、行距及排列等应满足本规定。 5.2页面设置 版面干净无底灰，自己清楚无断划，尺寸标准，版心不斜，版心尺寸为156mm*235mm。页面设置要求为： 上边距32±1mm，下边距30mm±1mm； 左边距28mm±1mm，右边距26mm±1mm； Word文档格式中“段落”缩进和间距设置为0，对其方式选“两端对其”。 5 详细要求 5.1技术文档封面 每份技术文档都应有封面，封面内容包括份号、密级、项目名称、文档名称、文档编号、研制单位名称和编制日期，技术文档封面样式见附录1. “份号：XXXX”（四号黑体），应位于封面版心左上方顶格标识，标识该份技术文档的顺序号，顺序号应用三位阿拉伯数字表示。 “密级：XX”（四号黑体），应位于封面版心右上方顶格标识技术文档密级依据项目签订密级确定，所有技术文档密级与所签项目密级保持一致。 “项目名称”（二号黑体），应位于份号下空三行（四号字，行间距设置为1.5倍行距）居中位置，当技术文档内容较多时，可分册装订，并标识技术文档分册号，如“（第一分册）”、“（第二分册）”。 “文档名称”（二号黑体）位于项目名称下方空三行（小四号字，行间距设置为1.5倍行距）居中标识。 “文档代号”（二号黑体）位于文档名称下方空一行（小四号字，行间距设置为1.5倍行距）居中标识。文档代码和配置项代码表示规则一致。 技术文件的代号一般情况由项目标识、文档标识和版本标识组成。其形式为： 项目标识格式为：项目名称代码-子类代码（当存在子系统时使用子类代码）。项目名称应以软件任务书定义为准，项目名称代码-子类代码取用项目名称特征词组汉字的首字母组合或特征字符串。注意代码不能重复，且在一个项目中必须统一。代码举例见表.1。 表1 项目标识举例 项目名称 项目代码 仿真软件 FZ 作战推演软件 ZYTY 常用文档标识代码表如下： 表1常用文档标识举例 软件文档名称 代码 软件任务书 RRW 软件项目开发计划 RXJ 软件质量保证计划 RZJ 软件配置管理计划 RPJ 软件需求规格说明 RXQ 接口需求规格说明 RJX 软件概要设计说明 RGS 软件详细设计说明 RXS 软件设计说明 RSS 接口设计说明 RJS 数据库设计说明 RKS 单元测试 软件测试计划 RCJ-DY 组装测试 RCJ-ZZ 确认测试 RCJ-QR 单元测试 软件测试说明 RCS-DY 组装测试 RCS-ZZ 确认测试 RCS-QR 单元测试 软件测试分析报告 RCF-DY 组装测试 RCF-ZZ 确认测试 RCF-QR 软件用户手册 RYC 软件研制报告 RYB 软件质量保证报告 RZB 软件配置管理报告 RPB 软件设计更改及影响域分析报告 RGB 软件质量问题技术归零报告 RGL 说明：软件文档标识代码可以根据实际需要自行添加，亦可修改上述代码。注意代码不能重复，且在一个项目中必须统一。 版本标识用于对版本加以区分、检索和跟踪，以表明各个版本之间的关系，版本号为数字结构，由以圆点相隔的四位阿拉伯数字组成。标识具体格式为：系统工程研制阶段（定型软件时适用）/技术状态.00.00，具体内容见表3“系统工程研制阶段标识”和表4“版本号表示”。随不同技术状态的版本变更，更新版本标识。 表3 系统工程研制阶段标识 研制阶段 研制阶段标识 说明 模样(或方案) M（或F） 对照行业标准或体系文件进行对准 初样 C 试样 S 定型 Dn n＝1，2，3…，表示不同批组 表4 版本号表示 格式 00. 00 位置 左边（第一层版本号） 右边（第二层版本号） 范围 01.-99. 00-99 说明 功能或性能变化时的版本升级。 最初版本号为01.，当有功能或性能变化时