GJB 438C中规定软件文档的用途与编写时机

转载于：北方自动控制技术研究所 2024年08月10日  系列标准宣贯︱GJB 438C中规定软件文档的用途与编写时机

感谢大佬的无私奉献。

一、较GJB 438B减少的文档

GJB 438C-2021《军用软件开发文档通用要求》相较于GJB 438B，在修订时减少了一些文档类型，具体包括：

- 软件配置管理计划

- 软件质量保证计划

- 软件输入/输出手册

- 软件中心操作员手册

- 计算机操作手册

- 软件配置管理报告

- 软件质量保证报告

- 软件研制任务书

这些文档的删减反映了标准对军用软件开发文档管理的简化和优化，旨在减轻文档负担，提高效率，同时也可能意味着相关要求被整合到了其他文档中或以更灵活的形式存在。

二、文档的用途与编写时机

GJB 438C-2021《军用软件开发文档通用要求》规定了一系列军用软件开发过程中必须编制的文档，这些文档的用途及编写时机如下：

1. 软件开发计划 (SDP)

- 用途：概述软件开发的总体计划，包括项目范围、目标、任务分配、时间表、资源需求、质量保证措施、风险管理等。

- 编写时机：项目启动初期，在需求分析完成之后，作为整个项目规划的基础。

2. 软件安装计划 (SIP)

- 用途：详细说明软件安装的步骤、所需的硬件配置、用户培训、现场支持等。

- 编写时机：软件开发接近完成时，确保部署与用户环境兼容，准备培训和安装活动。

3. 软件移交计划 (STrP)

- 用途：规划软件及相关文档、工具、数据等资产向用户或保障机构的正式交接。

- 编写时机：软件测试完毕，准备部署前，确保平稳过渡到用户手中。

4. 软件测试计划 (STP)

- 用途：定义软件测试的策略、测试环境、用例、时间表、质量标准等。

- 编写时机：需求确定后，设计初期，与开发同步进行，确保测试的覆盖和及时反馈。

5. 运行方案说明 (OCD)

- 用途：详细说明系统运行的条件、操作步骤、维护要求、故障处理等。

- 编写时机：设计阶段，确保运行和维护活动与系统设计相符。

6. 系统/子系统规格说明 (SSS)

- 用途：定义系统或子系统功能、性能、接口需求、设计限制。

- 编写时机：需求分析后，指导系统设计和开发。

7. 接口需求规格说明 (IRS)

- 用途：详细描述系统组件间的接口需求，包括数据格式、通信协议。

- 编写时机：需求分析阶段，确保各部分间交互明确。

8. 系统/子系统设计说明 (SSDD)

- 用途：详述系统或子系统设计，包括架构、模块设计、数据结构。

- 编写时机：设计阶段，基于需求和规格说明。

9. 接口设计说明 (IDD)

- 用途：描述接口的具体设计，如数据结构、控制机制。

- 编写时机：设计阶段，细化接口实现。

10. 软件需求规格说明 (SRS)

- 用途：明确软件的功能、性能、用户接口、环境等需求。

- 编写时机：需求分析，为设计提供依据。

11. 软件设计说明 (SDD)

- 用途：描述软件内部设计细节，如模块、数据流、算法。

- 编写时机：设计阶段，依据RS进行。

12. 数据库设计说明 (DBDD)

- 用途：详细说明数据库设计，包括结构、关系、索引挚等。

- 编写时机：数据库设计阶段。

13. 软件测试说明 (STD)

- 用途：测试方法、案例、条件、标准的说明。

- 编写时机：测试准备阶段。

14. 软件测试报告 (STR)

- 用途：测试结果、问题、分析、建议的总结。

- 编写时机：测试后，评估阶段。

15. 软件产品规格说明 (SPS)

- 用途：定义产品的功能、性能、用户接口、交付形式。

- 编写时机：产品定义阶段。

16. 软件版本说明 (SVD)

- 用途：记录软件版本信息、变更历史、版本间差异。

- 编写时机：版本发布前后，更新时。

17. 软件用户手册 (SUM)

- 用途：指导用户安装、操作、维护软件。

- 编写时机：开发后期，接近完成。

18. 计算机编程手册 (CPM)

- 用途：提供编程环境、工具、指南。

- 编写时机：开发初期，程序员使用。

19.固件保障手册（FSM, Firmware Support Manual）

-用途：为用户提供关于系统中固件设备编程、维护和再编程所需的详细信息。这类文档特别关注于确保固件设备的正确管理，包括擦除、加载软件、验证加载过程和标记等操作。它通常包括但不限于以下内容：

- 预编程设备的综述，介绍固件设备的制造商、型号和物理特性。

- 写入设备的软件，列出与设备相关的软件信息。

- 编程设备，描述用于编程的设备和工具。

- 编程软件，涉及编程操作的软件工具。

- 编程规程，详细的编程步骤和注意事项。

- 安装和修复规程，包括安装、替换和故障排除指南。

- 供应商信息，提供供应商联系和产品支持详情。

- 编写时机：通常是在固件开发和集成阶段接近完成时进行，确保所有相关编程和维护信息准确无误，以便系统集成后能顺利进入部署和维护阶段。固件保障手册的编制通常紧跟固件设计与验证之后，确保所有技术细节在固件最终确定后被准确记录下来，这样用户或维护人员在需要对固件进行操作时有可靠的操作指南。此外，手册也可能在固件经过初步测试并证明可行后开始编写，以确保在系统交付前所有必要的文档准备就绪。

20.软件研制总结报告（ SDSR,Software Development Summary Report）

-用途：对软件开发项目进行全面的回顾和总结，其核心目标包括但不限于：

- 总结经验教训：记录软件开发过程中采取的方法、遇到的问题、采取的解决方案及效果，为未来项目提供可借鉴的经验。

- 评估项目绩效：对照项目初期设定的目标、预算、时间表，评估实际完成情况，包括技术成果、成本控制、时间管理等。

- 技术成果展示：详细介绍软件的功能、性能、架构设计、关键技术实现及其达到的技术指标。

- 问题与改进建议：指出项目实施过程中发现的问题及未达成目标的原因分析，并提出改进建议。

- 后续工作规划：对于项目后续的维护、升级或相关联的项目，提出建议或规划。

- 成果归档：为项目留下正式的文档记录，作为组织知识库的一部分，供日后参考或审计使用。

-编写时机：软件研制总结报告通常在软件开发项目的主要工作完成且通过了必要的测试验收之后进行编写。这通常意味着软件已经进入了部署阶段或者即将交付给用户，所有关键的开发活动和测试都已经结束。此时，团队拥有完整的项目数据和实践经验，能够对整个研发过程进行深入反思。编写SDSR也是项目收尾阶段的一个重要组成部分，通常在项目正式关闭前完成，以便于项目评审、存档和内部分享学习。

以上文档在软件开发的各个阶段发挥着关键作用，从需求分析、设计、编码、测试到部署维护，直至项目总结，确保软件生命周期中的每个环节都有明确的文档记录和指导。编写时机的选择对于保证文档的时效性和实用性至关重要，应当与软件开发的进度紧密同步进行。

三、剪裁要求

GJB 438C-2021《军用软件开发文档通用要求》中的文档剪裁要求旨在确保软件开发文档既能满足项目具体需求，又避免不必要冗余，以提高文档的针对性和实用性。具体要求概括如下：

1. 文档种类和内容的调整：承制方（即软件开发方）可以根据所选择的软件生命周期模型、合同规定以及实际进行的活动来确定项目中需要产生的文档种类。允许对文档的种类进行合并、拆分或内容的剪裁，以适应项目实际情况。

2. 合并文档：当两个或多个文档内容相近或相互关联时，可以考虑将其合并为一个文档，以一个文档为主，有机整合其他文档内容，同时需确保合并后文档的完整性，并在文档注释中明确说明合并情况及理由。

3. 拆分文档：若单一文档过于庞大或内容繁杂，可以拆分成多个文档，每个拆分后的文档应满足第4.3节关于文档组成的各项基本要求，确保拆分前后内容的一致性，并在其中一个文档的注释中说明拆分情况。

4. 内容剪裁原则：对于标准中规定的文档内容，如果某些章节或条款不适用于特定项目，可以进行剪裁。剪裁时，应当在被剪裁的章节或条款标题下标注“本章无内容”或“本条无内容”，并明确剪裁的原因。对于整章或整条（连同其下的所有子条）被剪裁，仅需在最顶级的标题下做相应标注。

5. 标记与说明：对于数据库或其他格式的文档，剪裁信息可以通过目录表中的标记来体现。此外，文档中的每一页都应有唯一的页号，必要时还包括文档号、版本号和修订号等信息。