3软件文档国家标准xcz.pptVIP

第三章 软件文档国家标准 第三章 软件文档国家标准 3.1 软件产品开发文档编制指南 3.2 软件需求说明编制指南 3.3 计算机软件测试文档编制规范 3.4 软件文档管理指南 3.1 软件产品开发文档编制指南 3.1.1软件文档的组成 3.1.2各类文档的内容要求 3.1.1软件文档的组成 计算机软件产品开发文档编制指南（GB 8567-1988）是一份指导性文档，目的是使得所编制的软件文档确实能够起到应该发挥的作用。 指南对软件文档的意义和作用、文档与读者的关系、软件生存周期与各种文档的编制、文档编制中的考虑因素、文档编制的管理工作以及各种文档的内容要求都作了详细描述，并给出了各类文档的编写提示。 3.1.1软件文档的组成 根据该指南，一项计算机软件的开发过程中，一般应产生如下十四种文档： （1）可行性研究报告 （2）项目开发计划 （3）软件需求说明书 （4）数据要求说明书 （5）概要设计说明书 （6）详细设计说明书 （7）数据库设计说明书 （8）用户手册 （9）操作手册 （10）模块开发卷宗 （11）测试计划 （12）测试分析报告 （13）开发进度月报 （14）项目开发总结报告 3.1.1软件文档的组成 （1）可行性研究报告 可行性研究报告编写的目的： （1）说明该软件开发项目的实现在技术、经济和社会条件方面的可行性 （2）评述为了合理地达到开发目标而可能选择的各种方案 （3）说明并论证所选定的方案。 编制时间：可行性研究与计划阶段 （2）项目开发计划 编制项目开发计划的目的： 用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度、 所需经费预算、所需软、硬件条件等问题作出的安排记载下来，以便根据本计划开展和检查本项目的开发工作 编制时间：可行性研究与计划、需求分析 3.1.1软件文档的组成 （3）软件需求说明书 软件需求说明书编制目的： 为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解， 使之成为整个开发工作的基础。 编制时间：需求分析阶段 （4）数据要求说明书 软件需求说明书的编制目的： 向整个开发时期提供关于被处理数据的描述和数据采集要求的技术信息。 编制时间：需求分析阶段 3.1.1软件文档的组成 （5）概要设计说明书 概要设计说明书又可称系统设计说明书，这里所说的系统是指程序系统。 编制的目的： 说明对程序 系统的设计考虑，包括程序系统的基本处流程、程序系统的组织结构、模块划分、功能分配、接口设计、 运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。 编制时间：软件设计阶段 3.1.1软件文档的组成 （6）详细设计说明书 详细设计说明书又可称程序设计说明书。 编制目的： 说明一个软件系统各个层次中的每一个程序 （每个模块或子程序）的设计考虑，如果一个软件系统比较简单，层次很少，本文件可以不单独编写，有关内容合并入概要设计说明书 编制时间：软件设计阶段 3.1.1软件文档的组成 （7）数据库设计说明书 编制目的： 是对于设计中的数据库的所有标识、逻辑结构和物理结构作出具体的设计规定 编制时间：软件设计阶段 （8）用户手册 编制目的： 是要使用非专门术语的语言，充分地描述该软件系统所具有的功能及基本的使用方法。使用户（或潜在用户）通过本手册能够了解该软件的用途，并且能够确定在什么情况下，如何使用它 编制时间：需求分析、软件设计、实现 3.1.1软件文档的组成 （9）操作手册 操作手册的编制目的： 向操作人员提供该软件每一个运行的具体过程和有关知识，包括操作方法的细节 编制时间：软件设计、编码与实现 （10）模块开发卷宗 是在模块开发过程中逐步编写出来的，每完成一个模块或一组密切相关的模块的复审时编写一份，应该把所有的模块开发卷宗汇集在一起。 编制目的：是记录和汇总低层次开发的进度和结果，以便于对整个模块开发工作的管理和复审，并为将来的维护提供非常有用的技术信息。 编制时间：编码与实现、测试 3.1.1软件文档的组成 （11）测试计划 这里所说的测试，主要是指整个程序系统的组装测试和确认测试（有效性测试） 编制目的： 是为了提供一个对该软件的测试计划，包括对每项测试活动的内容、进度安排、设计考虑、测试数据的整理方法及评价准则 编制时间：需求分析、软件设计 （12）测试分析报告 编写目的：是为了把组装测试和确认测试的结果、发现及分析写成文件加以记载 编写时间：测试 3.1.1软件文档的组成 （13）开发进度月报 开发进度月报的编制目的： 是及时向有关管理部门汇报项目开发的进展和情况，以便及时发现和处 理开发过程中出现的问题。一般地，开发进度月报是以项目