软件文档编写规定.doc

软件文档编写规定无锡航天长峰电子技术研究所企业标准QQ/CFDZ2102005 拟 制： 审 核： 会 签： 标 准 化： 批 准：1 范围本标准规定了软件文档的组成、标识和编制要求等。本标准适用于软件文档的编制。2 引用文件下列文件中的有关条款通过引用而成为本标准的条款。凡注日期或版次的引用文件，其后的任何修改单（不包括勘误的内容）或修订版本都不适用于本标准，但提倡使用本标准的各方探讨使用其最新版本的可能性。凡不注日期或版次的引用文件，其最新版本适用于本标准。QQ/CFDZ111 软件工程化管理程序QQ/CFDZ201 技术文件归档签署规定3 术语和定义3.1 计算机软件文档技术数据或信息，包括计算机的列表和打印输出。计算机软件文档可记录计算机软件的要求、设计或细节，解释软件的能力和限制条件，或提供在软件运行期中使用或保障计算机软件的操作指令。4 职责4.1 产品标准化总师负责确定产品软件文档的齐套性要求；4.2 软件室产品软件负责人负责组织软件文档的编制。5 规定5.1 软件文档的组成在软件开发过程中可能产生的文档按技术文件归档签署规定中的软件文档完整性表。5.2 软件文档的标识5.2.1 标识的组成标识由产品代号、软件标识、文档简号、版本号和密级代号组成。5.2.2 标识的填写规定a) 产品代号由科研部下发；b) 软件标识按各产品设计与试验规范的规定填写；c) 文档简号见表1；d) 版本号按软件入库时定义的版本号；e) 密级代号按保密有关规定填写。5.3 软件文档的编制方法5.3.1 软件文档的格式a) 纸质软件文档的格式按硬件产品技术文件；b) 可执行文件可使用光盘（或软盘）作为复制载体。5.3.2 软件文档的编写a) 软件文档内容编写，参照GJB438A-1997规定，制定了各个文档的编写提示见附录A；b) 为使各文档章节的信息更加清晰可读，可采用图、表、矩阵或其它形式的表示方式进行说明；c) 合同有要求时，按顾客规定的要求编制软件文档。5.3.3 标准文档的剪裁除另有规定外，本标准规定的各种软件文档可根据各产品的性质、特点等具体情况进行剪裁，并应在产品的软件设计与编码规范中明确。如：产品规模较小时，可将“软件需求规格说明”和“接口需求规格说明”合并拟制，接口的需求可插入“软件需求规格说明”文档中；“计算机系统操作员手册”、“软件用户手册”和“软件程序员手册”可将有关章节合并至“软件用户手册”中；对于无人机界面的软件，其有关操作、使用方法和注意事项等可写入系统的技术说明书和使用说明书中。5.3.4 程序汇总表的编写5.3.4.1 程序汇总表是对电子设备中所有程序（包括可编程器件配置文件）在设备中配置情况的具体描述，供组织和管理生产使用。程序汇总表的填写，有以下规定：a) “软件标识或编号”栏填写程序的标识（包括产品代号、版本号和密级代号）或可编程器件的S整件的编号（包括版本号和密级代号）。当多个CSCI或CSC或CSU合装在一个固件中时，除在首栏填写组合程序的标识外，还需在其下栏填写每个CSCI或CSC或CSU的标识；b) “名称”栏填写各程序的功能名称；c) “编号”栏填写各程序装入的固件所在的SP整件编号（所有装有程序的硬件需编制SP整件）；d) “位置代号”栏填写SP整件所在系统中的位置；e) “种类代号”栏填写固件所在电路中的种类代号；若一个程序分开装入二个以上固件时，应在相应栏内填写各固件所在电路中的种类代号；f) “整机工作令号”填写整机产品的工作令号和台（套）号，如第二批960产品共十套，其第一套的整机工作令号填写960-023-10-1：。如果本程序汇总表中包括其它软件产品、且该软件产品有单独的汇总表时，则该软件产品汇总表中的程序不再汇入本汇总表，需在本汇总表末尾加以引述，如：“成套软件产品的程序汇总表见CFDZ1.231.011RH”。5.3.4.2 单元或分系统的程序汇总表可以将可编程逻辑器件的S整件汇总表和软件的程序汇总表分别汇总提交给总体，也可以合并汇总在一份汇总表中。5.3.4.3 提交归档的程序汇总表应包括可编程逻辑器件的S整件和软件的程序。程序汇总表整机工作令号序号软件标识或编号程序装入SP整件文件号名称编号位置代号种类代号备注更改附录A（规范性附录）软件文档编写提示各文档的内容、结构层次划分可按本提示和正文5.3.2条的规定编写。A.1 软件质量保证计划编写提示1 目的本计划的目的在于对所开发的,软件规定各种必要的质量保证措施，以保证交付的,软件能够满足项目委托单位的各种需求，能够满足开发任务书规定的各项具体需求。2.引用文件按文档号和标题列出本文档引用的所有文档。3 软件质量保证机构与职责4 软件质量控制程序和要求4.1 软件评审4.2 软件文档管理4.3 软件配置管理4.4 软件更改管理4.5 软件的测试、验收4.6 外购、外协软件的质量控制根据需要而定4.7 质量记录的收集、维护和保存 描述准备计划、维护、评审和执行软件质量保证活动的记录。标识要使用的格式和要记录的信息。4.8 软件的维护A.2 系统分析和段设计文件编写提示1 范围1.1 标识列出本文档的：a) 已批准的标识号；b) 标题；c) 缩略语；d) 本文档适用的系统；e) 由系统设计所派生需求的更高层的规格说明。1.2 概述概述本文档所适用的系统和CSCI的用途。1.3 文档概述概述本文档的用途和内容。2 引用文档按文档号和标题列出本文档引用的所有文档。3 运行概念分节描述系统的运行概念。3.1 任务3.1.1 用户要求描述系统必须满足的用户要求，并引用描述这些要求的文档。3.1.2 主要任务描述系统的主要任务。3.2 支持环境描述在系统生产和部署阶段所需的支持环境。3.2.1 支持硬件描述系统正常运行需要的硬件环境。3.2.2 支持软件描述系统正常运行需要的软件环境。3.4 系统体系结构描述系统的内部结构，标识子系统、HWCI和CSCI，并概述其用途。描述子系统、HWCI和CSCI之间的关系。标识和陈述系统每个内部接口的用途，用系统体系结构框图表示系统顶层的体系结构。3.5 运行情况描述系统的每一种运行情况。对每个系统状态和方式，应标识其执行的配置项和执行的手工操作，也可以用图表表示。此外，还应描述系统以不同的状态和方式运行时，配置项之间执行的控制流程和数据流程。4 系统设计本章应标识系统内部被指定为主要项目或关键项目的HWCI。分小节标识系统的每个HWCI、CSCI和手工操作，还应描述系统内部HWCI、CSCI和手工操作之间的关系，也可用树型框图描述配置项之间的关系。4.1 HWCI标识分小节描述分配给每个HWCI的系统需求。4.1.X (HWCI名称和项目唯一标识号)从4.1.1节开始编号,用名称和项目唯一标识号标识-HWCI，并陈述它的用途。标识由系统和段规范分配给HWCI的每个需求，标识由HWCI决定的每个系统功能的名称和项目唯一标识号。系统的每个外部接口都要用标准术语（如:输入/输出电压、维数、冗余度、负载、速度等）详细描述，并描述HWCI的设计约束。4.2 CSCI标识分小节描述分配给每个CSCI的系统需求。4.2.X (CSCI名称和项目唯一标识号)从4.2.1节开始编号,用名称和项目唯一标识号标识CSCI，并陈述它的用途。标识由系统和段规范分配给CSCI的每个需求，标识由HWCI决定的每个系统功能的名称和项目唯一标识号。系统的每个外部接口都要用标准术语（如：位/秒、字长、消息格式、消息频率、优先权规则、协议等）详细描述。并描述CSCI的设计约束。4.3 手工操作标识分小节描述分配给每个手工操作的系统需求。4.4 内部接口分节描述系统内部每个接口及其系统中接口与配置项之间关系，并可以引用系统内部接口框图。4.4.X (接口名称和项目唯一标识号）从4.4.1节开始编号，用名称和项目唯一标识号标识系统内部所有的接口，标识模块间传输的每个信号。5 处理资源分小节描述系统的处理资源。5.X (处理资源名称和项目唯一标识号)从5.1节开始编号,用名称和项目唯一标识号标识处理资源、系统使用的配置项。对每个处理资源要指定其使用特性。例如对计算机硬件还应定义下列特征：a) 内存大小：计算机内部存储器（独立、共享或全部）的大小；b) 字长：每个计算机字的位数；c) 处理速度：计算机处理器能力（独立、共享或全部）（如在全部配置运行时有的余量）；d) 字符集标准：如：Unicodee) 中断能力：硬件的中断能力；f) 直接存储器访问（DMA）：DMA的数据传输；g) 辅助存储器：辅助存储器容量（独立、共享或全部）；h) 其他；6.质量因素的考虑根据情况，分小节指明质量因素和质量度量的模型，包括相关的评价标准。A.3 软件开发计划编写提示1 范围1.1标识引出本文档的：a) 已批准的标识号；b) 标题；c) 缩略语；d) 本文档适用的计算机软件配置项（CSCI）。并标明CSCI的标题、缩写和标识号。1.2 概述概述本文档所适用的系统和CSCI的用途。1.3 文档概述概述本文档的用途和内容。1.4 与其它计划的关系概述本计划与其它项目开发计划的关系。2 引用文档按文档号和标题列出本文档引用的所有文档。3 软件开发管理分节描述与软件开发管理活动相关的计划。3.1 项目组织与资源分小节叙述承制方的项目组织和项目资源。3.1.1 承制方的设施叙述用于完成合同的设施。醒目地标出安全保密范围和简述安全保密活动的特点。还要醒目标出特定的资源，如：软件工程环境。3.1.2 管理部门提供的设备、软件和服务描述为完成合同要求由管理部门提供的所有设备、软件、服务和设施，其中包括何时需要的详细进度表。要醒目的标出在系统规范、主要项目或关键项目开发说明中未列出的但要求的项目。3.1.3 组织机构概述承制方软件项目组织机构。标识每个组织的权限和职责，可以用图表来表示此信息。3.1.4 人员描述完成软件开发项目必须的人员数量，指明项目管理、软件工程、正式软件测试、软件产品评价、软件配置管理以及本计划标识的其它功能分别所需的人员数目及总数。3.2 进度和里程碑3.2.1 活动以承制方主要进度表为基础，简要的叙述项目的每个软件开发活动及其相应的进度。开发进度还应指明所有的重要事件，如评审、审查、关键会议等等。进度表可以用图表提供。对每一个活动，进度表应标出：a) 活动的起始点；b) 正式和非正式文档的草稿和最终拷贝的编写起止日期；c) 活动完成点；d) 高风险区域。3.2.2 活动网络描述项目活动中的顺序关系，标出完成项目对活动要求的最长时间和完成的时间余量。这些信息可以用图表提供，例如采用-./0 图。3.2.3 来源标识标识并描述软件开发所需资源（软件、固件和硬件）的来源。提供一份获得所需资源的计划，并且应说明要求的日期和每个资源项应如何使用。3.3 风险管理描述为成功完成项目而对风险区域进行管理的计划。包括：a) 标识项目的风险区域并确定各风险区的优先级；b) 标识引起风险的因素；c) 将监控风险因素和减少风险发生的措施和计划编写成文档；d) 标识与每个风险区域有联系的规程。3.4 安全保密描述承制方为实现合同的安全保密性要求而制定的计划。3.5 与其它承制方的接口描述为保证与有关的承制方的兼容性所作的协调设计和数据管理的工作。3.6 与其它软件独立验证与确认机构的接口描述与软件独立验证与确认机构的接口。3.7 转承制方的管理描述对转承制方的管理。3.8 正式审查描述承制方准备和提交正式审查的内部程序。3.9 软件开发库描述承制方用来控制软件和有关文档的软件开发库。3.10 纠正过程描述实施的纠正工作过程。3.11 问题/更改报告描述使用的问题/更改报告的格式。这些报告用于记载检测到的软件及其文档的问题，并且记述解决这些问题需要做的纠正工作。报告包括下列数据选项：a) 系统或项目名称：本报告应用的系统或开发项目名称；b) 编制者：提交本报告的人或机构的名字和电话号码；c) 问题号：指定的问题编号；d) 问题名称；e) 涉及的软件元素或文档：本报告应用的特定软件元素、文档小节号，包括配置标识和版本号；f) 编制日期：报告首次提交的日期；g) 类型和优选次序；h) 问题描述：问题和产生此问题的条件、输入和设备配置的描述。导致问题发生的活动。允许复制和分析的问题信息与其它要报告的问题和修改的关系；i) 分析者：姓名、电话号码和单位；j) 委派日期：委派分析者的日期；k) 完成日期：完成分析的日期；l) 分析时间：分析问题要求的时间；m) 建议方案：问题分析后的建议方案。并简要描述建议方案的特点，基本原理和测试结果；n) 影响：方案采纳后对费用、进度和接口的影响。方案未采纳时，对性能、其它系统、配置项、其它承制方、系统使用者、集成后的后勤保障、系统资源和训练等的影响；o) 问题状态：由配置控制程序决定的问题状态；p) 方案的批准者：由配置控制权限任命；q) 所起的作用：问题解决后带来的作用；r) 校对者：姓名、电话号码和委派机构；s) 校对日期；t) 版本号：问题校对的版本；u) 校对时间：校对问题需求的时间；v) 实现方案：简述解决问题方案。4 软件工程分节描述与软件工程相关的活动。4.1 组织和资源分小节描述软件工程活动所必须的组织、责任和资源。4.1.1 组织机构描述负责执行软件工程活动的组织，包括每个组织的权限和责任，以及与其它组织实体的关系，如负责执行软件质量评价的组织。如果不止一个组织，每个组织的结构、人员和资源以及他们内部之间的关系也要醒目的标出。4.1.2 人员描述执行软件工程活动的人员数量和技术水平（包括职务和职称），并说明特定岗位的需求，如地理位置、安全保密级别等。4.1.3 软件工程环境分小节标识和描述执行软件工程活动所需的资源（软件、固件和硬件）的建立和维护的计划。4.1.3.1 软件项标识执行软件工程活动所必须的软件项，如操作系统、编译器、代码检查器、动态路径分析器、测试驱动器、预处理器、测试数据产生器、后置处理器等。描述每个项目的目的，并标识与软件项相关的分类和安全保密性问题。4.1.3.2 硬件和固件项标识用于软件工程环境的计算机硬件、接口设备和固件项。描述每一项的目的，并标出与硬件和固件项相关的分类和安全保密性问题。4.1.3.3 权限标识出与软件工程环境每个项目相关的所有权和管理机构或使用者的权限。4.1.3.4 安装、控制和维护制定安装和测试每个软件工程环境项目的计划，描述控制和维护每个软件工程环境项目的计划。4.2 软件标准和研制程序分小节描述计划使用的软件标准和研制程序。4.2.1 软件开发技术和方法标识和描述计划执行的技术和方法：a) 软件需求分析；b) 概要设计；c) 详细设计；d) 编码和CSU测试；e) CSU集成和测试；f) CSCI测试。4.2.2 软件开发文件定义承制方的计划，包括对软件开发文件的创立和维护负有责任的组织机构，定义软件开发文件的格式和内容，描述维护软件开发文件的程序。4.2.3 设计标准描述在软件开发中计划使用的设计标准。4.2.4 编码标准描述在开发软件中计划使用的编码标准。4.3 非开发软件标识并描述每一个准备组合到交付软件中的非开发软件项，如：商品软件、重用软件、管理机构或使用方提供的软件，并简要描述每一个非开发软件项的基本原理。5 正式合格性测试分小节描述与正式合格性测试活动有关的计划。5.1 组织机构和资源分小节描述正式合格性测试所需的组织和资源。5.1.1 组织机构描述负责执行正式合格性测试的组织。包括组织的权限和责任，以及与其它组织实体的关系，如负责执行软件工程的组织。如果不止一个组织，每个组织的结构、人员和资源以及他们内部之间的关系也要醒目的标出。5.1.2 人员描述执行正式合格性测试的人员数量和技术水平（包括职务和职称），并说明特定岗位的需求，如地理位置、安全保密级别等。5.2 测试方法/基本原理描述执行正式合格性测试的方法和基本原理。5.3 测试计划的假设条件和约束描述测试计划中所作的假设条件和签约机构对正式合格性测试施加的约束。6 软件产品评价分节描述与软件产品评价活动相关的计划。6.1 组织机构和资源分小节描述软件产品评价所需的组织和资源。6.1.1 组织机构描述负责执行软件产品评价的组织，包括每个组织的权限和责任，以及与其它组织实体的关系，如负责执行软件工程的组织，如果不止一个组织，每个组织的结构、人员和资源以及他们内部之间的关系也要醒目的标出。6.1.2 人员描述执行软件产品评价人员的数量和技术水平（包括职务和职称），并说明特定岗位的需求，如地理位置、安全保密级别等。6.2 软件产品评价规程和工具分节描述软件产品评价的规程和使用的评价工具。6.2.1 评价规程描述用于评价软件和相关文档的规程。6.2.2 评价工具标识并描述软件产品评价中使用的工具。工具的描述要说清楚该工具在评价过程中的用途。为减少重复可引用软件工程和软件测试环境中使用的工具。6.3 转承制方的产品描述为评价转承制方的需求是否满足以及评价转承制方产品而制定的计划和规程。6.4 软件产品评价记录描述准备和维护每个产品评价记录的计划，标识使用的格式和每个评价记录的信息，并描述维护记录和便于管理机构审查所制定的计划。6.5 依赖活动的产品评价分小节描述执行每个软件开发产品的产品评价的计划。本节还要说明任何计划修改的或GJB2786要求之外的评价标准，并列出在每个软件开发活动中安排进行的产品评价（开发活动指，系统要求分析/设计、软件需求分析、概要设计、详细设计、编码和CSU测试、CSC集成和测试、CSCI测试，以及系统集成与测试）。6.5.X 软件产品评价（活动名）从6.5.1节开始编号,描述在每一活动中安排的评价计划,并标识指定的被评价产品、使用的评价标准、评价程序和工具。对软件开发计划中进行评价的项目，要指定取样方法和被评价项目所占的比率。7 软件配置管理分节描述与软件配置管理活动相关的计划。7.1 组织机构和资源分小节描述软件配置管理所需的组织和资源。7.1.1 组织机构描述负责执行正式合格性测试组织。包括每个组织的权限和责任，以及与其它组织实体的关系，如负责执行软件工程的组织。如果不止一个组织，每个组织的结构、人员和资源以及他们内部之间的关系也要醒目的标出。7.1.2 人员描述执行软件配置管理的人员的数量和技术水平（包括职务和职称），并说明特定岗位的需求，如地理位置、安全保密级别等。7.2 配置标识7.2.1 开发配置标识标识CSCI开发所使用的承制方内部开发配置。并描述每个标识的开发配置的内容及建立方法。7.2.2 标识方法描述标识（如：起名字、作标号、作编号）及修改CSCI、CSC、CSU和文档的方法。描述怎样对要标识的CSCI、CSC、CSU和文档作修订。7.3 配置控制分小节详细描述用于控制开发配置和内部控制的文档，及维护开发配置和内部控制的文档的规程。7.3.1 配置控制流程描述提交、审查和是否赞同问题及其修改的过程（见图1）。图1 配置控制流程示例7.3.2 报告的文档分小节描述和引用报告的文档。例如，用于控制软件问题及其更改的通知单和工程更改建议。7.3.2.X 报告名称从7.3.2.1节开始编号- 描述或引用要完成的报告的格式、内容和指令。7.3.3 审查规程分小节描述与配置控制流程相关的审查部门的目的及其所使用的审查规程。7.3.3.X 审查委员会名称/规程从7.3.3.1节开始编号-描述审查委员会的目的和遵守的规程。描述审查委员会如何与配置标识模式联接，以提供历史的可追踪性。7.3.4 项目介质的存储、处置和交付描述在开发过程中，要交付软件及文档的存储、处置和交付的正式规程。7.3.5 其它控制标识上面未讨论的其它配置控制活动。7.4 配置状况报表定义使用的配置状况报表系统。并描述状况记录和报告的内容、格式和用途。7.5 配置审核描述承制方保障和执行配置审核计划。在执行审核中，也要描述如何使用配置状况报告和记录。7.6 认可规格说明的准备描述承制方准备以及响应认可规格说明的规程。包括：a) 把规格说明提交鉴约机构进行审查和认可；b) 确保体现已批准的更改；c) 更改配置状况报表的报告已反应批准的基线。7.7 配置管理主要里程碑标识为满足合同要求，与软件配置管理相关的内部的里程碑或管理机构的里程碑。8 其它软件开发功能分节描述包括在软件开发中的其他承制方的功能。8.X (功能名)从8.1节开始编号,描述要执行的功能。描述执行此功能所需的组织机构、资源以及方法与规程。8.X.1 组织机构（功能名）从8.1.1开始编号,描述负责执行此功能的组织。包括每个组织的权限和职责，以及与其他组织实体，如执行配置管理职责的组织的关系。如果包括一个以上组织，那么每个组织结构和资源，以及他们之间的关系要醒目地标出。8.X.2 人员（功能名）描述执行此功能的人员的数量和技术水平。人员的描述要有职务和职称。此外，还要说明特定岗位的需求，如地理位置、安全保密级别等。8.X.3 其它资源（功能名）标识和描述执行此功能所必需的任何其它资源。对每个资源，要简要描述其功能。8.X.4 方法和规程（功能名）描述执行此功能所使用的方法和规程。A.4 软件设计与编码规范1 适用范围概述本文档适用的系统或CSCI。2 引用文件列出本文档引用的所有文档。3 术语和定义列出本文档使用的术语和定义。4 软件设计要求4.1 软件设计方法指出软件系统的设计方法（如结构化设计、面向对象设计等），并加以描述。4.2 软件设计工具规定软件开发过程中所使用的软件工具，具体包括下列各项内容，应根据需要列出：a) 分析、设计工具；b) 编程/调试环境；c) 测试工具；d) 软件管理工具；同一软件系统或CSCI中，宜使用统一的软件工具。4.3 软件设计表示规定或指定软件文档中各种软件表示所使用的图形规范。如：a) 表示软件系统需求的功能分配图（如UML用例图）；b) 描述与软件有关的系统硬件物理拓扑结构的软件配置图（如UML配置图）；c) 表示对象间的交互，及交互中行为次序的软件时序图（如UML顺序图、协作图）；d) 表示软件构架的软件结构图（如UML构件图）；e) 表示系统状态转换过程的软件状态图（如状态图和UML活动图）；f) 描述软件中类与包的软件类图（针对OO）（如UML的类图）；g) 表示软件程序流程的软件基本流程图；h) 表示软件数据流程的数据流程图。4.4 软件标识描述以下与软件标识有关的内容：a) 系统中使用的软件标识的命名规则；b) 系统中CSCI标识名；c) 使用系统分解和CSCI分解图，对系统进行顶层分解，简要描述系统中各CSCI及其组成；d) 尽可能给出系统中其他软件标识名。4.5 相关标识定义列出已给定的硬件和外部标识名，以便软件系统统一使用。4.6 源代码文件名命名描述在形成软件源代码时，如何根据软件标识名形成软件源代码文件名。4.7 系统关键参数定义对软件系统中全局性的参量名及术语进行定义，如坐标系、惯性平台参数、通讯协议等。可在本节规定整个系统的数据字典。4.8 软件文档根据技术文件完整性要求规定，给出在软件设计过程中应该形成的文档，按软件文档编写规定编写文档。5 软件编码规范明确指出系统或CSCI中使用的语言种类，应根据所使用语言制定编码规范，并依次进行说明。下列各条规定了对软件编码规范内容的要求。5.1 源代码布局：对源代码布局进行规定，系统中同一语言种类的程序要使用统一的源代码布局。5.2 程序注释：每个程序在开始部分必须有注释，注释内容包括版权信息、文件名、标识号、摘要、背景介绍、当前版本、作者名称、创建时间、完成时间、修改者名称、等。5.3 函数注释：有独立功能意义的函数/子程序要有注释，注释内容包括输入、输出、函数描述、流程处理、全局变量、调用模块、更改记录（更改者、日期）等；5.4 内容注释：对程序中的关键内容要加以注释，程序中简单的注释（单行）可写在语句之后；复杂的注释与被注释语句在同一缩进上对齐；注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。5.5 函数及变量命名规则：给出函数或变量命名规则；5.6 程序风格：要求对影响程序风格的以下内容进行约定：a) 一行最大代码长度；b) 函数/子程序的最大行数；c) 一个可编译源程序的最大行数；d) TAB键定义；e) 代码缩进的使用。A.5 软件需求规格说明编写提示1 范围1.1 标识列出本文档的：a) 批准的标识号；b) 标题；c) 缩略语d) 本文档适用的系统和计算机软件配置项（CSCI）。e) 本文档的规格。1.2 CSCI概述简述系统的用途，标识和描述本文档适用的CSCI在系统中的作用。1.3 文档概述概述本文档的用途和内容。2 引用文档按文档号的标题列出本文档引用的所有文档。3 工程需求分节详细说明必要的工程需求，确保CSCI的正确开发。这里包括的各项需求是从相应的“系统和段设计文件”或其它文档所建立的需求中分配或派生出来的。3.1 CSCI外部接口需求标识CSCI的外部接口。为了帮助描述，可使用外部接口框图。每个外部接口应标识其名称和项目唯一标识号，并简述每一个接口。对每个接口还应注明所有文档资料（如接口需求规格说明）的来源。3.2 CSCI的功能需求分小节标识该CSCI必须满足的所有功能需求。如果该CSCI所在的系统在该系统规范中对各种系统状态和方式作了描述，则本节应标识每个这样的状态和方式，并将每个CSCI的功能与这些状态和方式联系起来，可使用一张表格叙述这种联系。3.2.X (功能名和项目唯一标识号)从3.2.1节开始编号。用名字和项目唯一标识号标识该CSCI的功能，陈述此功能的用途并用可度量的术语描述它的性能。各节应标识和陈述与该功能有关的每个输入输出的用途，标识该功能全部满足或部分满足的已分配的或派生出的各项需求。如果该项功能更清晰地分解为若干子功能，则用一个或多个小节提供每个子功能的需求，给每个子功能赋予一个项目唯一的标识号，此标识号可从功能的标识号中派生。3.3 CSCI的内部接口标识在上面表示的各项功能之间的接口。每个内部接口应当用名字和项目唯一标识号标识，并简要描述每个接口，包括在接口上传递的信息概要。可使用描述数据流、控制流和其它有关信息的内部接口图帮助说明各内部接口。3.4 CSCI数据元素要求本节应详细说明下面列出的各项信息：a) 对于CSCI内部的数据元素；1) 赋给数据元素一个项目唯一标识号；2) 简要描述数据元素；3) 标识数据元素的测量单位，如秒、米、千赫等；4) 标识数据元素的极限值/值域（若为常数，则提供实际值）；5) 标识数据元素的精确度；6) 用有效数字标识数据元素的精度或分辨率；7) 内部接口数据元素；用名字和项目唯一标识号标识该接口；用名字和项目唯一标识号标识数据元素的来源；用名字和项目唯一标识号标识数据元素的目的地。b) 对于CSCI的外部接口的数据元素；1) 用项目唯一标识号标识数据元素；2) 用名字和项目唯一标识号标识该接口；3) 尽可能用名字和项目唯一标识号标识来源和目的地；4) 引用详细描述指定的接口的“接口需求规格说明”。3.5 适应性要求分节详细说明CSCI适应现场具体条件和系统环境改变的各种要求。3.5.1 依赖安装的数据描述每次安装所需现场具体的数据，例如：场地的纬度、经度、雷达的范围和有效区以及规定的安全限制等。此外，还需说明使用这些数据的CSCI的功能。3.5.2 操作参数描述CSCI所需的、根据操作要求可在指定的范围内变化的一些参数。例如：允许的弹道偏差、导航定位模型数目、飞机性能特性、飞机出动架次的干扰/故障、导弹性能特性。本节还需说明使用这些数据的CSCI的功能。3.6 容量和时间要求应规定分配给该CSCI的内存和辅助存储器的容量和位置，以及处理时间。本节还应规定CSCI所需的存储器和中央处理器所需的资源。3.7 安全要求描述为避免人员、财产和物理环境等潜在危害所作的安全要求设计。3.8 保密要求描述为避免敏感数据可能的丢失所作的保密要求设计。3.9 设计约束指明约束CSCI设计的其它要求，如使用特殊的处理器配置等。3.10 人的特性/人的工程需求详细说明CSCI对人员因素的工程需求，包括：a) 人的信息处理能力和限制；b) 在正常条件和极限条件下可预见的人为错误；c) 总的系统环境（包括培训、保障和操作环境）的影响。3.11 需求可追踪性需求可追踪性包括把本文档的工程需求变换到适用于在“系统和段设计文件”等中的CSCI的需求的映射，本节还应提供来自“系统和段设计文件”等的CSCI的需求分配变换到本规格说明中的工程需求的映射。4 合格性需求分节规定合格性方法，以及证实该CSCI满足本文档第3章和第5章的需求所必需的特殊合格性需求。4.1 合格性方法和级别详细说明用于确保满足本文档第3章和第5章中的CSCI需求的合格性审查方法，例如可使用类似于表1的形式来表示。表1 交叉引用表的例子需求名称标识号本文第三章节号合格性方法a)合格性级别b)软件测试说明中章节号转手数据CAP103-A3.2.10.3A34.2.10记录数据CAP205-C3.2.13.5A14.2.13注：a)合格性方法：A-分析；D演示；Z检查； b)合格性级别：1-配置项；2-系统集成；3-系统；4-系统安装。a) 合格性方法包括：1) 演示：对CSCI（或部分CSCI）的进行直接可观察的功能操作，不需要使用复杂或专用的测试设备；2) 分析：处理从其他合格性方法获得的累计数据，例如：对测试数据的整理分析和归纳；3) 检查：对CSCI的编码、文档等的直观检查等。b) 合格性级别划分如下：1) 配置项：在CSCI中发现的质量问题；2) 系统集成：在系统集成时发现的问题；3) 系统：在系统中发现的质量问题；4) 系统安装：在系统安装时发现的质量问题。5 交付准备说明要交付的CSCI介质的类型和特性（例如8磁道磁带1600BPI、150兆字节的磁盘）。本章还应说明介质的标签、包装、处置和分类标记的要求，包括CSCI的名字和项目唯一标识号。任何特殊的交付要求也要在此说明。A.6 专题研究与试验总结报告编写提示1 范围“范围”一章可采用以下典型用语：本报告为系统产品中进行专题研究与试验的总结。介绍了方案、关键技术、达到的目标、试验记录和结论。本标准适用于系统产品的专题研究与试验工作。2 引用文件列出在报告中引用的文件。各级标准按标准代号、名称排列。文件按文件名称、机关名称、日期、文件号等依次排列。3 术语和定义列出报告中使用的需要定义或说明的术语、缩略语、符号和代号等。4 专题研究方案设计概述本文档所适用的系统，分节描述研究的内容。4.1 专题背景描述专题研究所要解决的问题在系统中的位置、作用，问题产生的背景。4.2 方案概述描述专题研究的技术方案。4.3 关键技术分析列出方案中的关键技术，解决途径。4.4 达到的目标列出专题研究达到的性能和功能。5 专题试验5.1 试验环境描述为进行专题研究试验所使用的资源（软件、固件和硬件）。5.1.1 软件项列出为进行专题研究试验使用的软件项（如，操作系统、编译器、编码审核器、动态路径分析器、测试驱动器、预处理器、测试数据产生器、后处理器），描述并说明每个项目的用途。5.1.2 硬件和固件项列出为进行专题研究试验所使用的计算机硬件、接口设备和固件项。描述并说明每个项目的用途。5.2 试验过程概述对专题研究的试验过程进行描述。5.3 试验记录对专题研究的试验过程进行记录。记录内容包括试验的日期、次数、参加人员、初始条件、软件的输入、输出、硬件的变化。6 分析和结论描述对专题研究试验所做的数据整理的分析过程。并说明根据整理和分析得到的信息和结果。数据记录、整理和分析的结果应清楚地显示出是否达到测试目标。A.7 接口设计文档编写提示1 范围1.1 标识列出本文档的：a) 已批准的标识号；b) 标题；c) 本文档适用的系统和计算机软件配置项（CSCI）。1.2 系统概述概述系统的用途、标识和描述各接口在系统中的作用。1.3 文档概述概述本文档的用途和内容。2 引用文档按文档号的标题列出本文档引用的所有文档。3 接口设计分小节描述本文档应用的各接口的接口设计。3.1 接口示意图详细说明本文档适用的每个CSCI以及与其它HWCI、CSCI和关键项连接的关系。3.X 接口名称和项目唯一标识号3从3.2节开始编号。各节应当用名称和项目唯一标识号标识一个接口，并陈述它的用途。分节描述该接口的设计。3.X.1 数据元素从3.2.1开始编号。对每个接口间的数据元素，在数据元素定义表中提供下列信息：a) 数据元素的项目唯一标识号；b) 数据元素的简短描述；c) 数据元素来源于CSCI、HWCI还是关键项；d) 数据元素的用户是各个CSCI、HWCI还是各个关键项；e) 数据元素的测量单位，如秒、米、公里等；f) 数据元素的极限值/值域（若是常数，提供实际值）；g) 数据元素的精确度；h) 用有效数字表示的数据元素的精度/分辨率；i) 数据元素被计算或更新的频率，如10kHz或50ms；j) 数据元素执行的合法性检查；k) 数据类型，如整型、字符串、定长、实型、枚举型等；l) 数据表示和格式；m) 数据元素的优先级。3.X.2 消息描述从3.2.2节开始编号,各节应当用名称和项目唯一标识号标识接口间的每个消息,并描述数据对每个消息的功用,本节应提供每个消息与组成该消息的各数据元素的交叉引用，而且还应提供每个数据元素与各数据元素的交叉引用。3.X.3 接口优先级从3.2.3节开始编号，各节应规定接口和通过该接口所传递的每个消息的相对优先次序。3.X.4 通信协议从3.2.4节开始编号，分节描述与该接口相联的商用、军用或专用的通信协议。3.X.4.Y （协议名称）从3.2.4.1节开始编号，各节应标出一个协议的名称,并描述该协议的技术细节。通信规格说明应陈述：a) 消息碎片和消息重新聚合；b) 消息格式；c) 错误控制和恢复过程，包括故障容错特性；d) 同步，包括建立连接、维护、终止和定时；e) 流程控制，包括顺序号、窗口大小和缓冲器分配；f) 数据传输率、周期还是非周期的传递，以及传输之间的最小间隔6g) 路由、编址和命名约定；h) 发送服务，包括优先级和等级；i) 状态、标识、通知单和其它报告特征；j) 安全保密，包括密码、用户授权、安全域划分和审计等。A.8 软件设计文档1 范围1.1 标识列出本文档的：a) 已批准的标识号；b) 标题；c) 缩略语；d) 本文档适用的系统和计算机软件配置项（CSCI），并标识派生该CSCI需求的更高层的规格说明。1.2 系统概述概述本文档所适用的系统和该系统的用途。1.3 文档概述概述本文档的用途和内容。2 引用文档按文档号和标题列出本文档引用的所有文档。3 概要设计分节描述CSCI的概要设计。3.1 CSCI概述描述CSCI在系统中的作用，指出CSCI的每个外部接口的用途，可以使用系统结构图指出该CSCI和系统中其它的CSCI的相互关系。3.1.1 CSCI结构描述CSCI的内部结构，应指明计算机软件部件（CSCI）和其下一级的CSC及其用途，并描述各CSC间的相互关系。该关系要指出各CSC到CSC接口的用途，并概述通过接口传送的数据。本节还应指出所有被合并到CSCI的非开发软件。CSCI顶层结构可以用图表示。3.1.2 系统状态和模式指出每一个CSCI操作的系统状态和模式以及在这一状态和模式下执行的CSC。并通过列举每个CSC执行的系统状态和模式来说明CSCI状态表。另外，本节应描述在不同状态和模式下各CSC之间执行的控制流程和数据流程，可使用流程图说明在每个状态和模式下的执行的控制流和数据流。3.1.3 内存和进程时间分配提供分配给CSC的内存和进程时间。并通过一个内存/进程时间表来描述此分配（参见表1）。表1 CSC内存/处理时间量表示例CSC名称CSC号内存预算（WORDS）分配的进程时间模式控制251700128ms雷达控制26300096ms武器控制272100100ms目标占用11170010ms执行1120080ms数据库1002000N/A其它69900156ms总计12600570ms可使用量16384740ms余留量23233.2 CSCI设计说明分小节提供CSCI中的每一个CSC的设计说明。3.2.X (CSC的名称和项目唯一标识号)从3.2.1开始编号,各节应指出CSC的名称和项目唯一标识号及其用途。各节应提供以下信息：a) 标识由需求规格说明分配给CSC的需求。如果CSC是由下一级的一些CSC组成的，则可以引用下一级的CSC描述部份信息或全部信息；b) 利用执行控制流和数据流来描述CSC的概要设计。如果CSC是由下一级的一些CSC组成，应标识下一级各CSC之间的相互关系。另外，应在软件需求规格说明文档中标识每个CSCI的内部接口。内部接口应由CSC和它的下一级CSC定位；c) 描述CSC的设计需求和设计约束，如果CSC是由下一级的一些CSC组成，则可引用下一级的CSC的部分信息和全部信息。3.2.X.Y (下一级CSC的名称和项目唯一标识号)从3.2.1.1节开始编号，标识下一级的CSC的名称和项目唯一标识号及其用途，以及提供3.2.X中c项所需要的信息。如果没有下一级CSC，就不用写这一节。如果CSC也是由下一级CSC组成的，要标识每个CSC的名称和项目唯一标识号。而且，下一级的CSC都要用单独一节来描述3.2.X中c）项所要求的信息。4 详细设计分节描述每个CSC的详细设计。4.X CSC的名称和项目唯一标识号从4.1节开始编号。分小节标识和描述CSC的每一个计算机软件单元CSU。用CSU间的控制流和数据流描述CSU间的关系。并标识CSC与外部联接的所有接口。对于那些被多个CSC使用的CSU，应详细的描述在一个CSC下的情况，其它的CSC只需要引用。4.X.Y CSU的名称和项目唯一标识号从4.1.1节开始编号。标识CSU的名称和项目唯一标识号，并指出CSU的用途。可以再分小节提供CSU的设计信息。4.X.Y.1 (CSU的名称)的设计及约束从4.1.1.1节开始编号。指出CSU的设计要求。标识分配给CSC的需求，需求应是由CSU全部或部分满足的。另外还要标识CSU设计中所有约束条件。定义的设计需求应包括人机接口的设计需求。4.X.Y.2 (CSU的名称)的设计从4.1.1.2节开始编号，给出CSU的设计说明。如果CSU不是用CSCI规定语言编写，那么要标识这一程序语言，并且阐述使用该语言的基本原理。如果CSU保存在库中，则各节要标识库的名称和项目唯一的标识号以及描述该库的设计文档。下面给出CSU详细的设计信息，这些信息可以通过自动化工具或其它技术提供，例如程序设计语言、流程图或其它设计方法。a) 输入/输出数据元素。标识并指出每个输入/输出数据元素的用途。数据元素的设计信息将在本文档第5章提供；b) 局部数据元素。标识并指出每个在CSU中产生且不被其它CSU所使用的数据元素的用途。每个数据元素可用名称、简单的描述、数据类型、数据表示、大小、度量单位、极限值/值域、精确度、精度/分辨率以及任何其它的数据属性。这些信息可以在CSU局部数据定义表中提供；c) 中断和信号。标识和描述CSU处理的中断和信号。同时，要标识每个中断和信号的信号源、用途、优先级、期望响应及响应时间、最小值、最大值和发生的概率；d) 算法。标识和简述CSU的功能，详细地描述CSU的执行算法。算法可以用输入操作和局部数据元素以及产生输出数据元素来描述；e) 错误处理。标识和描述CSU的错误诊断和恢复特征，包括对错误的输入数据和影响CSU执行的其它条件的处理；f) 数据转换。标识和描述为实现CSU的接口要执行的数据转换操作；g) 其它元素的使用。描述CSU所使用的其它元素的用途，它包括，但不仅限于：1) 其它CSU（例如：库函数调用、访问数据库的I/O服务调用、大容量存储设备及实时I/O通道）；2) 全局内存的共享存储数据（例如：数据库或数据文件、表、公用池、数据池等等）；3) 输入输出缓冲，包括信息缓冲；h) 逻辑流程图。根据a到g项描述CSU的逻辑流程，并描述CSU执行时初始化的条件、调用的通信接口的特征以及其它CSU控制条件。若在CSCI的操作期间序列是被动态的控制，则应描述控制的方法和该方法的逻辑和输入条件，例如时间变化、优先级赋值、诸如输入/输出、内部存储器的数据传送的内部操作、离散输入信号的读出以及与CSCI的中断操作的时间关系；i) 数据结构。描述CSU实现的局部数据结构以及CSU所使用的所有共享数据结构；j) 局部数据文件和数据库。如果数据文件或数据库是CSU的局部数据的一部分，那么应指出每个数据文件或数据库的用途，并用记录、字段等术语描述该文件或数据库的结构和访问过程（顺序的或随机的）；k) 局限性。描述限制CSU性能的局限性或不通用特征。5 CSCI数据描述CSCI的全局数据元素。为便于可读和易维护，可用一个或几个表提供如下信息，这些信息可提供给所有的数据元素。a) CSCI内部的数据元素：1) 数据元素的名称；2) 简要描述；3) 测量单位，例如秒、米等；4) 数据元素值的极限值/值域（对常数要给出实际值）；5) 数据元素要求的精确度；6) 精度/分辨率（用有效数字表示）；7) 对于实时系统，计算或刷新数据元素的频率，如10kHz、50ms等；8) 数据元素的合法性检查；9) 数据类型，如整型、字符、定点数、实型、枚举型等等；10) 数据表示格式；11) 对数据元素设置值或做赋值计算的CSU的项目唯一标识号；12) 数据元素的CSU的项目唯一标识号；13) 数据的来源，例如数据库或数据文件、全局公共块、局部公共块、公用池、数据池、参数等等。每个数据的来源都要用它的项目唯一标识号标识；b)CSCI外部接口的数据元素应是：1) 标识数据元素；2) 用名称和项目唯一标识号标识接口；3) 引用描述外部接口的接口设计文档。6 CSCI数据文件分节描述CSCI的每个共享数据文件。6.1 CSC/CSU数据文件的交叉引用为CSC和CSU使用下列每个数据文件提供一个映像。6.2 (数据文件名和项目唯一标识号）用名称和项目唯一标识号标识被多个CSU共享的CSCI数据文件。并陈述数据文件的用途，标识文件的最大尺寸，描述文件的访问方法（如随机的或顺序的）。还应提供文件中各记录的结构和大小，描述驻留在文件中的数据：数据类型、数据表示、大小、度量单位、极限值 值域、精确度、精度 分辨率以及数据的其它属性。这些信息可用一个文件或一张表提供。7 需求可追踪性应提供分配给每个CSC的上一级CSU，可追溯到软件需求规格说明和接口需求规格说明要求的需求。可追踪性可以用图形来表示。A.9 软件产品规格说明编写提示1 范围1.1 标识列出本文档的：a) 已批准的标识号；b) 标题；c) 缩略语；d) 适用的CSCI和系统。1.2 系统概述概述本文档所适用的系统和CSCI的用途。1.3 文档概述概述本文档的用途和内容。2 引用文档按文档号和标题列出本文档引用的所有文档。3 要求分节写出或引用附录所包含的所有设计文档和用于CSCI的列表。3.1 软件设计写出或引用附录或其它文件所包含的软件设计文档。3.2 源代码列表本节