GB8567-88 模块开发卷宗模板

来源:软件工程国家标准文档集(GB 8567-88《计算机软件产品开发文件编制指南》配套模板,2001 年 Word 9.0 建档) 性质:模块级开发文档的归档卷宗目录模板,一页纸的强制目录结构

卷宗组成(7 个必备部分)

  1. 标题页 —— 软件系统名称和标识符;模块名称和标识符(卷宗含多个模块时用模块组的功能标识代替);程序编制员签名;修改文本序号与完成日期;卷宗序号;编排日期
  2. 模块开发情况表
  3. 功能说明 —— 扼要说明本模块(组)的输入、要求的处理、输出;可从系统设计说明书摘录;须列出软件需求说明书中对应功能的章、条、款
  4. 设计说明 —— 三层设计考虑:
    • 系统设计说明书层面:模块在系统中的层次、与其他模块的接口
    • 程序设计说明书层面:算法、处理流程、数据文卷设计限制、驱动方式、出错信息
    • 编码层面:编制已通过全部测试的源代码时实际使用的设计考虑
  5. 原代码清单 —— 第一份无语法错源代码清单 + 已通过全部测试的当前有效源代码清单(两者都要)
  6. 测试说明 —— 每一项直接针对本模块的测试:标识符和编号、测试目的、方法与输入、预期输出及实际输出
  7. 复审的结论 —— 实际测试结果与软件需求说明书/系统设计说明书/程序设计说明书的要求比较并给出结论

要点解读

  • 该模板体现瀑布模型时代的文档可追溯性思想:卷宗把需求条目 → 设计 → 代码 → 测试 → 复审结论串成一条证据链,任何一环缺失即归档不合格
  • 与现代实践的对应关系:标题页≈文档版本控制;功能/设计说明≈README+架构决策记录;测试说明≈测试用例矩阵;复审结论≈DoD/测试总结报告
  • 与同目录其他 GB8567 模板(可行性研究报告、软件开发计划、测试计划等)构成完整的 14 类文档体系

关联