GB/T 33784-2017 可编程逻辑器件软件文档编制规范

　　ICS 35 . 080 L 77

　　中 华 人 民 共 和 国 国 家 标 准

　　GB/T 33784—2017

　　可编程逻辑器件软件文档编制规范Specificationofprogrammablelogicdevicesoftwaredocumentation

　　2017-05-31 发布 2017-12-01 实施

　　中华人民共和国国家质量监督检验检疫总局中 国 国 家 标 准 化 管 理 委 员 会

　　发

　　布

　　GB/T 33784—20 17

　　GB/T 33784—20 17

　　前 言

　　本标准按照 GB/T 1 . 1—2009 给出的规则起草。

　　请注意本文件的某些内容可能涉及专利。 本文件的发布机构不承担识别这些专利的责任。

　　本标准由全国信息技术标准化技术委员会(SAC/TC 28)提出并归口 。

　　本标准起草单位：中国航天科工集团第三研究院第三 ○四研究所、中国电子技术标准化研究院、上海计算机软件技术开发中心。

　　本标准主要起草人：张津荣、刘军、李丽华、李娜、朱琳、刘伟、王颖、孟伟、彭鸣、杨楠、张清、张旸旸、刘潇健、于秀明、郝守勤、蔡立志、赵静、张志刚、李思、吕宗辉、张明敏、刁立峰、杨源、李卓、姚可成。

　　GB/T 33784—20 17

　　可编程逻辑器件软件文档编制规范

　　1 范围

　　本标准规定了可编程逻辑器件软件开发过程编制的主要文档及其编制的内容、格式等要求。

　　本标准适用于可编程逻辑器件软件开发过程中文档的编制。

　　2 规范性引用文件

　　下列文件对于本文件的应用是必不可少的。 凡是注 日期的引用文件，仅注 日期的版本适用于本文件 。凡是不注日期的引用文件，其最新版本(包括所有的修改单)适用于本文件。

　　GB/T 8567—2006 计算机软件文档编制规范

　　GB/T 11457—2006 软件工程术语

　　GB/T 33781—2017 可编程逻辑器件软件开发通用要求

　　3 术语和定义

　　GB/T 11457—2006 和 GB/T 33781—2017 中界定的术语和定义适用于本文件。

　　4 一般要求

　　4 . 1 文档的产生

　　可编程逻辑器件软件文档应伴随各阶段的工作过程(见 GB/T 33781—2017 的表 A. 1)而产生。

　　4 . 2 文档介质

　　可编程逻辑器件软件开发过程中要编制的文档应为纸质或电子媒体的形式。

　　4 . 3 文档的结构

　　软件文档由封面、签署页、目录、正文组成，必要时增加注释和(或)附录(或附件)。

　　4 . 4 文档编制规则

　　文档内容的条款标题和顺序应与本标准规定的标题和顺序相同。 具体文档编制中，若所编制的文档不包含本标准规定的某个或某些条款的内容，则在相应条款的标题下直接加以说明，如，“此标题下无内容”。文档编制的相关具体要求如下：

　　a) 文档 目录 ：

　　目录在正文前面。

　　b ) 文档的页码：

　　文档的目录使用从 Ⅰ 开始的小写罗马数字编号，文档正文和附录使用阿拉伯数字顺序连续编写。

　　c) 正文条款编号和书写形式：

　　1) 文档正文的条款编号采用以下形式：

　　GB/T 33784—20 17

　　X 编号的第 1 层

　　X. X 编号的第 2 层

　　X. X. X 编号的第 3 层

　　X. X. X. X 编号的第 4 层

　　其中，X是阿拉伯数字字符，取值从 1 到 9 。

　　文档条款设置一般最多四层，即编号层次到 X. X. X. X 为止。

　　2) 在有标题的条款中，正文另起一行书写。

　　d) 公式 ：

　　文档中的公式应写在有关条文附近。 公式中符号的意义和计量单位，应注释在公式的下面。 同 一个文档中若有两个以上公式时，应在其后用带圆括号的阿拉伯数字顺序编号，编号应在整个文件中连续。

　　e) 插图 ：

　　文档中插图应安排在有关条文附近(流程图可列在有关章、条之后)。如有两个以上插图，应标以图号(如，图 1-1、图 1-2……),图号可用阿拉伯数字 1、2…表示，第一个数字表示章号，第二个数字表示顺序号，图号之后写其名称。

　　f) 表格 ：

　　表格一般排在有关条文附近。 同一个文档有两个以上表格时，应在整个文档中连续标注表号(如，表 1-1、表 1-2……),表号可用阿拉伯数字 1、2…表示，第一个数字表示章号，第二个数字表示顺序号，表号之后写其名称。

　　表格中相邻参数或文字相同时，以通栏表示，尽量不使用“同上”“同左”字样。

　　如果表格超过一页要转下页续排时，表的续表不必写表的名称，而在续表的上方居中位置写明“续表 X”。续表的表头不得省略。

　　g) 注和附录：

　　“注”中不能出现图表和公式。 如只有一条注，则在“注”字后面加冒号，接着写注释内容。 若同一处有两条以上注时，可在“注 ”字加冒号之后，用带圈的阿拉伯数字 ①、②…标识。

　　如有两个以上附录，用“附录”加一个英文大写字母的形式编号，编号顺序按英文字母顺序依次排列。

　　附录若有标题应写在“附录”后面。

　　附录的内容、插图、表格应在附录内单独编号。

　　附录的页码紧接着正文页码连续编排。

　　5 文档种类

　　在软件开发过程中一般产生下列主要文档：

　　a) 可编程逻辑器件软件可行性和风险分析报告;

　　b ) 可编程逻辑器件软件开发技术要求;

　　c) 可编程逻辑器件软件需求规格说明;

　　d) 可编程逻辑器件软件设计说明;

　　e) 可编程逻辑器件软件仿真测试计划;

　　f) 可编程逻辑器件软件仿真测试说明;

　　g) 可编程逻辑器件软件仿真测试报告;

　　h) 可编程逻辑器件软件确认测试计划;

　　i ) 可编程逻辑器件软件确认测试说明;

　　GB/T 33784—20 17

　　j) 可编程逻辑器件软件确认测试报告;

　　k) 可编程逻辑器件软件使用说明;

　　l ) 可编程逻辑器件软件开发总结报告。

　　其他文档编制规范参见 GB/T 8567—2006 。

　　6 文档内容及编排要求

　　6 . 1 可编程逻辑器件软件可行性和风险分析报告

　　《可编程逻辑器件软件可行性和风险分析报告》描述可编程逻辑器件软件的可行性和风险分析要求，内容包括：设计复杂度评估、功耗和时钟频率要求评估、防辐照方法、产品测试方法、封装要求、设计及测试工具(硬件和软件)、必要人力资源的可用性、确认潜在的风险项及对应的预防措施和意外计划。

　　《可编程逻辑器件软件可行性和风险分析报告》的正文内容要求如下：

　　GB/T 33784—20 17

　　6 . 2 可编程逻辑器件软件开发技术要求

　　《可编程逻辑器件软件开发技术要求》描述可编程逻辑器件软件开发的 目 的 、目标、主要任务、功能及性能指标等要求，是可编程逻辑器件开发的基础和依据。《可编程逻辑器件软件开发技术要求》应包括如下内容：

　　a) 运行环境要求：描述可编程逻辑器件软件运行环境的温度、电压、功耗、抗辐照等方面的要求;

　　b ) 接口关系：描述可编程逻辑器件软件的所有外部接口关系;

　　c) 安全关键性要求：描述可编程逻辑器件软件可靠性、冗余性、安全性等方面的要求;

　　d) 设计约束：描述可编程逻辑器件软件 IP核复用要求、资源余量和时序余量等方面的要求;

　　e) 管理要求：描述可编程逻辑器件软件的管理机构、管理办法、项 目开发进度、相关评审、控制节点等要求;

　　f) 质量保证：描述可编程逻辑器件标准、文档、配置管理、测试等方面的要求;

　　g) 验收与交付：描述可编程逻辑器件软件的验收准则，可编程逻辑器件软件的交付形式、数量、装载媒体，交付的文档清单和(需要时)可编程逻辑器件软件的版权保护等方面的要求;

　　h) 维护：描述可编程逻辑器件软件验收后出现问题的处理原则，包括可编程逻辑器件软件的改正、适应和完善性维护工作等方面的要求。

　　《可编程逻辑器件软件开发技术要求》的正文内容要求如下：

　　GB/T 33784—20 17

　　GB/T 33784—20 17

　　6 . 3 可编程逻辑器件软件需求规格说明

　　《可编程逻辑器件软件需求规格说明》描述可编程逻辑器件软件的功能需求、外部接口需求、内部接口需求，以及确保满足每个需求所使用的方法。

　　《可编程逻辑器件软件需求规格说明》的正文内容要求如下：

　　GB/T 33784—20 17

　　GB/T 33784—20 17

　　6 . 4 可编程逻辑器件软件设计说明

　　《可编程逻辑器件软件设计说明》描述可编程逻辑器件软件的结构/详细设计的技术要求，包括体系结构设计、功能模块设计及各功能子模块设计、接口设计及各子模块的内部接口关系、设计及约束(包括综合约束、布局布线约束等)、可追踪性等。

　　《可编程逻辑器件软件设计说明》的正文内容要求如下：

　　GB/T 33784—20 17

　　GB/T 33784—20 17

　　6 . 5 可编程逻辑器件软件仿真测试计划

　　《可编程逻辑器件软件仿真测试计划》描述可编程逻辑器件软件的仿真测试计划的技术要求，包括：仿真测试环境(仿真测试环境包括功能及时序仿真工具等)、仿真测试要求、测试进度表的安排、可追踪性等。

　　《可编程逻辑器件软件仿真测试计划》的正文内容要求如下：

　　GB/T 33784—20 17

　　6 . 6 可编程逻辑器件软件仿真测试说明

　　《可编程逻辑器件软件仿真测试说明》描述可编程逻辑器件软件仿真测试所需的测试准备、测试用例及测试过程。

　　《可编程逻辑器件软件仿真测试说明》的正文内容要求如下：

　　GB/T 33784—20 17

　　GB/T 33784—20 17

　　6 . 7 可编程逻辑器件软件仿真测试报告

　　《可编程逻辑器件软件仿真测试报告》是对可编程逻辑器件软件仿真测试结果的记录，包括测试结果概述、测试环境的影响、详细的测试结果、测试日志等。

　　《可编程逻辑器件软件仿真测试报告》的正文内容要求如下：

　　GB/T 33784—20 17

　　6 . 8 可编程逻辑器件软件确认测试计划

　　《可编程逻辑器件软件确认测试计划》描述可编程逻辑器件软件的确认测试计划的技术要求，包括：确认测试环境(确认测试环境包括硬件项和软件项、环境条件、辐照要求等)、确认测试要求、测试进度表

　　GB/T 33784—20 17

　　的安排、可追踪性等。

　　《可编程逻辑器件软件确认测试计划》的正文内容要求如下：

　　GB/T 33784—20 17

　　6 . 9 可编程逻辑器件软件确认测试说明

　　《可编程逻辑器件软件确认测试说明》描述可编程逻辑器件软件确认测试所需的测试准备、测试用例及测试过程。

　　《可编程逻辑器件软件确认测试说明》的正文内容要求如下：

　　GB/T 33784—20 17

　　GB/T 33784—20 17

　　6 . 10 可编程逻辑器件软件确认测试报告

　　《可编程逻辑器件软件确认测试报告》是对可编程逻辑器件软件确认测试结果的记录，包括测试结果概述、测试环境的影响、详细的测试结果、测试日志等。

　　《可编程逻辑器件软件确认测试报告》的正文内容要求如下：

　　GB/T 33784—20 17

　　6 . 1 1 可编程逻辑器件软件使用说明

　　《可编程逻辑器件软件使用说明》描述可编程逻辑器件软件适用的系统和可编程逻辑器件项 目 。 《可编程逻辑器件软件使用说明》应包括如下内容：

　　a) 芯片概述：描述可编程逻辑器件软件的芯片型号、配置芯片型号、开发环境、配置文件版本号等;

　　b ) 性能指标：描述可编程逻辑器件软件的工作时钟频率、工作电压、功能等;

　　c) 环境要求：描述可编程逻辑器件软件的工作温度要求、器件等级、抗辐照性能等;

　　d) 物理特性：描述可编程逻辑器件软件的芯片封装、管脚分配等;

　　e) 使用说明：描述可编程逻辑器件软件的通讯协议、操作时序等。

　　《可编程逻辑器件软件使用说明》的正文内容要求如下：

　　GB/T 33784—20 17

　　GB/T 33784—20 17

　　6 . 12 可编程逻辑器件软件开发总结报告

　　《可编程逻辑器件软件开发总结报告》描述可编程逻辑器件软件整个研制/开发情况。《可编程逻辑器件软件开发总结报告》应包括如下内容：

　　a) 任务来源与研制依据;

　　b ) 可编程逻辑器件软件概述;

　　c) 可编程逻辑器件软件研制过程：描述可编程逻辑器件软件研制过程的概述以及可编程逻辑器件软件研制各活动/阶段所采用的方法和工作产品等;

　　d) 可编程逻辑器件软件满足任务指标情况;

　　e) 可编程逻辑器件软件测试情况：描述可编程逻辑器件软件的仿真测试、确认测试、实验测试、验收测试、系统联试等;

　　f) 可编程逻辑器件软件第三方评测情况;

　　g) 质量保证情况：描述质量保证措施实施情况、可编程逻辑器件软件重大技术质量问题和解决情况等;

　　h) 配置管理情况：描述可编程逻辑器件软件配置管理要求、可编程逻辑器件软件配置管理实施情况、可编程逻辑器件软件配置状态变更情况等;

　　i ) 可编程逻辑器件软件可靠性、安全性分析：描述可编程逻辑器件可靠性、安全性要求所采用的措施分析;

　　j) 结论：评述可编程逻辑器件软件工程化实施情况，说明可编程逻辑器件软件功能和性能指标是否满足可编程逻辑器件软件开发技术要求的要求，给出可编程逻辑器件软件是否可以交付需方使用的结论。

　　《可编程逻辑器件软件开发总结报告》的正文内容要求如下：

　　GB/T 33784—20 17

　　GB/T 33784—20 17