第3章软件文档国家标准.ppt

2019 年 3 月 15 日星期五 1 软件文档与标准 徐承志 第 3 章 软件文档国家标准 2 2019 年 3 月 15 日星期五 软件文档国家标准 ? 软件工程标准分类 ? 基础标准 ? 开发标准 ? 文档标准 ? 管理标准 ? 我国有关软件开发过程中的四个主要依据 ? 文档编制指南（ GB/T8567-1988 ） ? 需求说明编制指南（ GB/T9385-1988 ） ? 测试文档编制规范（ GB/T9386-1988 ） ? 文档管理指南（ GB/T16680-1996 ） 3 2019 年 3 月 15 日星期五 3.1 计算机软件产品开发文档编制指南 (GB/T 8567-1988) ? 3.1.1 软件文档的组成（ 14 种文档） ? 可行性研究报告 ? 技术、经济和社会条件的可行性；评述各种方案；论证选定方 案。 ? 项目开发计划 ? 用文档的形式制定人员、进度、经费、软硬件资源计划。 ? 软件需求说明书 ? 供需双方对软件有一个基本的共识。 ? 数据要求说明书 ? 被处理的数据的描述和采集手段 ? 概要设计说明书 ? 又称为“系统设计说明书”，包括程序系统的基本流程、组织 结构、模块划分、功能分配、接口设计、运行设计、数据结构 设计和出错处理设计等。 “软件文档”与“系统分析 与设计”和“软件项目管理” 之间的关系。 4 2019 年 3 月 15 日星期五 3.1 计算机软件产品开发文档编制指南 ? 3.1.1 软件文档的组成（ 14 种文档） ? 详细设计说明书 ? 又称为“程序设计说明书”，针对系统内部结构中的程序进行 设计说明。 ? 数据库设计说明书 ? 数据库的所有标识、逻辑结构和物理结构。 ? 用户手册 ? 不要使用术语 ? 操作手册 ? 操作细节 ? 模块开发卷宗 ? 模块开发的过程中逐步编写出来，记录和汇总底层开发的进度 和结果，以便于管理、复审和维护。 5 2019 年 3 月 15 日星期五 3.1 计算机软件产品开发文档编制指南 ? 3.1.1 软件文档的组成（ 14 种文档） ? 测试计划 ? 主要指整个系统的组装测试和确认测试，包括测试 内容、进度、设计、测试数据的整理及评价准则。 ? 测试分析报告 ? 测试结果文档化。 ? 开发进度月报 ? 监控进度、及时发现问题。 ? 项目开发总结报告 ? 总结经验，并对整个开发工作进行评价。 6 2019 年 3 月 15 日星期五 3.1.2 各类文档的内容要求 ? 1. 可行性研究报告 一、引言 1. 编写目的； 2. 背景； 3. 定义； 4. 参考资料； 二、可行性研究的前提 1. 要求； 2. 目标； 3. 条件、假定和限制； 4. 进行可行性研究的方法； 5. 评价尺度； 三、对现有系统的分析 1. 数据流程和处理流程； 2. 工作负荷； 3. 费用开支； 4. 人员； 5. 设备； 6. 局限性； 四、所建议的系统 1. 对所建议系统的说明； 2. 数据流程和处理流程； 3. 改进之处； 4. 影响 ( 对设备 的影响，对软件的影响，对用户单位机构的影响，对系统运行的影响，对开发的 影响，对地点和设施的影响，对经费开支的影响 ) ； 5. 局限性； 6. 技术条件方面的 可行性； 7 2019 年 3 月 15 日星期五 3.1.2 各类文档的内容要求 ? 1. 可行性研究报告 五、可选择的其他系统方案 1. 可选方案 1 ； 2. 可选方案 2 ； …… 六、投资及收益分析 1. 支出 ( 基本建设投资、其他一次性支出、非一次性支出 ) ； 2. 收益 ( 一次性收益、非一次性收益、不可定量收益 ) ； 3. 收益 / 投资比； 4. 投资回收周期； 5. 敏感性分析； 七、社会条件方面的可行性 1. 法律方面； 2. 使用方面； 八、结论 8 2019 年 3 月 15 日星期五 3.1.2 各类文档的内容要求 ? 2. 项目开发计划 一、引言 1. 编写目的； 2. 背景； 3. 定义； 4. 参考资料； 二、项目概述 1. 工作内容； 2. 主要参加人员； 3. 产