软件文档编写规定Word格式.docx
《软件文档编写规定Word格式.docx》由会员分享，可在线阅读，更多相关《软件文档编写规定Word格式.docx（51页珍藏版）》请在冰豆网上搜索。
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标识
列出本文档的：
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.1HWCI标识
分小节描述分配给每个HWCI的系统需求。
4.1.X（HWCI名称和项目唯一标识号）
从4.1.1节开始编号,用名称和项目唯一标识号标识-HWCI，并陈述它的用途。
标识由系统和段规范分配给HWCI的每个需求，标识由HWCI决定的每个系统功能的名称和项目唯一标识号。
系统的每个外部接口都要用标准术语（如:
输入/输出电压、维数、冗余度、负载、速度等）详细描述，并描述HWCI的设计约束。
4.2CSCI标识
分小节描述分配给每个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）字符集标准：
Unicode
e）中断能力：
硬件的中断能力；
f）直接存储器访问（DMA）：
DMA的数据传输；
g）辅助存储器：
辅助存储器容量（独立、共享或全部）；
h）其他；
6.质量因素的考虑
根据情况，分小节指明质量因素和质量度量的模型，包括相关的评价标准。
○A.3软件开发计划编写提示
1.1标识
引出本文档的：
d）本文档适用的计算机软件配置项（CSCI）。
并标明CSCI的标题、缩写和标识号。
1.4与其它计划的关系
概述本计划与其它项目开发计划的关系。
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。
列出本文档引用的所有文
升级会员 