软件文档国家标准

《软件文档国家标准》由会员分享，可在线阅读，更多相关《软件文档国家标准（38页珍藏版）》请在金锄头文库上搜索。

1、软件文档与标准软件文档与标准软件文档与标准软件文档与标准第第3章章 软件文档国家标准软件文档国家标准软件文档国家标准软件文档国家标准v软件工程标准分类软件工程标准分类基础标准开发标准文档标准管理标准v我国有关软件开发过程中的四个主要依据我国有关软件开发过程中的四个主要依据文档编制指南（GB/T8567-1988）需求说明编制指南（GB/T9385-1988）测试文档编制规范（GB/T9386-1988）文档管理指南（GB/T16680-1996）3.1 3.1 计算机软件产品开发文档编制指南计算机软件产品开发文档编制指南 (GB/T 8567-1988)(GB/T 8567-1988)v3.1

2、.1 软件文档的组成（软件文档的组成（14种文档）种文档）可行性研究报告可行性研究报告技术、经济和社会条件的可行性；评述各种方案；论证选定方案。项目开发计划项目开发计划用文档的形式制定人员、进度、经费、软硬件资源计划。软件需求说明书软件需求说明书供需双方对软件有一个基本的共识。数据要求说明书数据要求说明书被处理的数据的描述和采集手段概要设计说明书概要设计说明书又称为“系统设计说明书”，包括程序系统的基本流程、组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等。“软件文档”与“系统分析与设计”和“软件项目管理”之间的关系。3.1 3.1 计算机软件产品开发文档编制指南

3、计算机软件产品开发文档编制指南v3.1.1 软件文档的组成（软件文档的组成（14种文档）种文档）详细设计说明书详细设计说明书又称为“程序设计说明书”，针对系统内部结构中的程序进行设计说明。数据库设计说明书数据库设计说明书数据库的所有标识、逻辑结构和物理结构。用户手册用户手册不要使用术语操作手册操作手册操作细节模块开发卷宗模块开发卷宗模块开发的过程中逐步编写出来，记录和汇总底层开发的进度和结果，以便于管理、复审和维护。3.1 3.1 计算机软件产品开发文档编制指南计算机软件产品开发文档编制指南v3.1.1 软件文档的组成（软件文档的组成（14种文档）种文档）测试计划测试计划主要指整个系统的组装测

4、试和确认测试，包括测试内容、进度、设计、测试数据的整理及评价准则。测试分析报告测试分析报告测试结果文档化。开发进度月报开发进度月报监控进度、及时发现问题。项目开发总结报告项目开发总结报告总结经验，并对整个开发工作进行评价。3.1.2 3.1.2 各类文档的内容要求各类文档的内容要求v1. 可行性研究报告可行性研究报告一、引言一、引言 1.编写目的；2.背景；3.定义；4.参考资料；二、可行性研究的前提二、可行性研究的前提 1.要求；2.目标；3.条件、假定和限制；4.进行可行性研究的方法； 5.评价尺度；三、对现有系统的分析三、对现有系统的分析 1.数据流程和处理流程；2.工作负荷；3.费用开

5、支；4.人员；5.设备； 6.局限性；四、所建议的系统四、所建议的系统 1.对所建议系统的说明；2.数据流程和处理流程；3.改进之处；4.影响(对设备的影响，对软件的影响，对用户单位机构的影响，对系统运行的影响，对开发的影响，对地点和设施的影响，对经费开支的影响)；5.局限性；6.技术条件方面的可行性；3.1.2 3.1.2 各类文档的内容要求各类文档的内容要求v1. 可行性研究报告可行性研究报告五、可选择的其他系统方案五、可选择的其他系统方案 1.可选方案1；2.可选方案2；六、投资及收益分析六、投资及收益分析 1.支出(基本建设投资、其他一次性支出、非一次性支出)； 2.收益(一次性收益、

6、非一次性收益、不可定量收益)； 3.收益/投资比；4.投资回收周期；5.敏感性分析；七、社会条件方面的可行性七、社会条件方面的可行性 1.法律方面；2.使用方面；八、结论八、结论3.1.2 3.1.2 各类文档的内容要求各类文档的内容要求v2. 项目开发计划项目开发计划一、引言一、引言 1.编写目的；2.背景；3.定义；4.参考资料；二、项目概述二、项目概述 1.工作内容；2.主要参加人员； 3.产品及成果(程序、文件、服务、非移交产品)； 4.验收标准；5.完成项目的最迟期限；6.本计划的审查者与批准者；三、实施总计划三、实施总计划 1.工作任务分解；2.接口人员；3.进度；4.预算；5.关

7、键问题；四、支持条件四、支持条件 1.计算机系统支持；2.用户承担的工作；3.外单位提供的条件；五、专题计划要点五、专题计划要点3.1.2 3.1.2 各类文档的内容要求各类文档的内容要求v3. 软件需求说明书软件需求说明书一、引言一、引言 1.编写目的；2.背景；3.定义；4.参考资料；二、任务概述二、任务概述 1.目标；2.用户特点；3.假定与约束；三、需求规定三、需求规定 1.对功能的规定；2.对性能的规定(精度、时间特性、灵活性)；3.输入输出要求；4.数据管理能力要求；5.故障处理要求；6.其他专门要求；四、运行环境规定四、运行环境规定 1.设备；2.支持软件；3.接口；4.控制；3

8、.1.2 3.1.2 各类文档的内容要求各类文档的内容要求v4. 数据要求说明书数据要求说明书一、引言一、引言 1.编写目的；2.背景；3.定义；4.参考资料；二、数据的逻辑描述二、数据的逻辑描述 1.静态数据；2.动态输入数据；3.动态输出数据；4.内部生成数据；5.数据约束三、数据的采集三、数据的采集 1.要求和范围；2.输入的承担者；3.处理；4.影响；3.1.2 3.1.2 各类文档的内容要求各类文档的内容要求v5. 概要设计说明书概要设计说明书一、引言一、引言 1.编写目的；2.背景；3.定义；4.参考资料；二、总体设计二、总体设计 1.需求规定；2.运行环境；3.基本设计概念和处理

9、流程； 4.结构；5.功能需求与程序的关系；6.人工处理过程；7.尚未解决的问题；三、接口设计三、接口设计 1.用户接口；2.外部接口；3.内部接口；四、运行设计四、运行设计 1.运行模块组合；2.运行控制；3.运行时间；五、系统数据结构设计五、系统数据结构设计 1.逻辑结构设计要点；2.物理结构设计要点；3.数据结构与程序的关系六、系统出错处理设计六、系统出错处理设计 1.出错信息；2.补救措施；3.系统维护设计；3.1.2 3.1.2 各类文档的内容要求各类文档的内容要求v6. 详细设计说明书详细设计说明书一、引言一、引言 1.编写目的；2.背景；3.定义；4.参考资料；二、程序系统的组织

10、结构二、程序系统的组织结构三、程序三、程序1(标识符标识符)设计说明设计说明 1.程序描述；2.功能；3.性能；4.输入项；5.输出项；6.算法；7.流程逻辑 8.接口；9.存储分配；10.注释设计；11.限制条件；12.测试计划； 13.尚未解决的问题；四、程序四、程序2(标识符标识符)设计说明设计说明 3.1.2 3.1.2 各类文档的内容要求各类文档的内容要求v7. 数据库设计说明书数据库设计说明书一、引言一、引言 1.编写目的；2.背景；3.定义；4.参考资料；二、外部设计二、外部设计 1.标识符和状态；2.使用它的程序；3.约定；4.专门指导；5.支持软件；三、结构设计三、结构设计

11、1.概念结构设计；2.逻辑结构设计；3.物理结构设计；四、运用设计四、运用设计 1.数据字典设计；2.安全保密设计；3.1.2 3.1.2 各类文档的内容要求各类文档的内容要求v8. 用户手册用户手册一、引言一、引言 1.编写目的；2.背景；3.定义；4.参考资料；二、用途二、用途 1.功能；2.性能(精度、时间特性、灵活性)；3.安全保密；三、运行环境三、运行环境 1.硬件设备；2.支持软件；3.数据结构 ；四、使用过程四、使用过程 1.安装与初始化；2.输入(输入数据的现实背景、输入格式、输入举例)； 3.输出(输出数据的现实背景、输出格式、输出举例)；4.文卷查询； 5.出错处理与恢复；

12、6.终端操作；3.1.2 3.1.2 各类文档的内容要求各类文档的内容要求v9. 操作手册操作手册一、引言一、引言 1.编写目的；2.背景；3.定义；4.参考资料；二、软件概述二、软件概述 1.软件结构；2.程序表；3.文卷表；三、安装与初始化三、安装与初始化四、运行说明四、运行说明 1.运行表；2.运行步骤； 3.运行1(标识符)说明(运行控制、操作信息、输入输出文卷、输出文段、输出文段的复制、启动恢复过程)； 4.运行2(标识符)说明.五、非常规过程五、非常规过程六、远程操作六、远程操作3.1.2 3.1.2 各类文档的内容要求各类文档的内容要求v10. 模块开发卷宗模块开发卷宗1.标题；

13、2.模块开发情况表模块标识符模块的描述性名称代码设计计划开始日期实际开始日期计划完成日期实际完成日期模块设计计划开始日期实际开始日期计划完成日期实际完成日期组装设计计划开始日期实际开始日期计划完成日期实际完成日期代码复查日期/签字源代码行数预计实际目标模块大小预计实际3.功能说明；4.设计说明；5.源代码清单；6.测试说明；7.复审的结论3.1.2 3.1.2 各类文档的内容要求各类文档的内容要求v11. 测试计划测试计划一、引言一、引言 1.编写目的；2.背景；3.定义；4.参考资料；二、计划二、计划 1.软件说明；2.测试内容； 3.测试1(标识符)(进度安排、条件、测试资料、测试培训)；

14、 4.测试2(标识符)三、测试设计说明三、测试设计说明 1.测试1(标识符)(控制、输入、输出、过程)； 2.测试2(标识符)四、评价准则四、评价准则 1.范围；2.数据整理；3.尺度3.1.2 3.1.2 各类文档的内容要求各类文档的内容要求v12. 测试分析报告测试分析报告一、引言一、引言 1.编写目的；2.背景；3.定义；4.参考资料；二、测试概要二、测试概要三、测试结果及发现三、测试结果及发现 1.运行1(标识符)； 2.运行2(标识符)；四、对软件功能的结论四、对软件功能的结论 1.功能1(标识符)(能力、限制)；2.功能2(标识符)五、分析摘要五、分析摘要 1.能力；2.缺陷和限制

15、；3.建议；4.评价；六、测试资源消耗六、测试资源消耗3.1.2 3.1.2 各类文档的内容要求各类文档的内容要求v13. 开发进度月报开发进度月报一、标题一、标题二、工程进度与状态二、工程进度与状态 1.进度；2.状态；三、资源耗用与状态三、资源耗用与状态 1.资源耗用(工时、机时)； 2.状态；四、经费支出与状态四、经费支出与状态 1.经费支出(支持性费用、设备购置费)；2.状态；五、下个月的工作计划五、下个月的工作计划六、建议六、建议3.1.2 3.1.2 各类文档的内容要求各类文档的内容要求v14. 项目开发总结报告项目开发总结报告一、引言一、引言 1.编写目的；2.背景；3.定义；4

16、.参考资料；二、实际开发结果二、实际开发结果 1.产品；2.主要功能和性能；3.基本流程；4.进度；5.费用；三、开发工作总结三、开发工作总结 1.对生产效率的评价； 2.对产品质量的评价；3.对技术方法的评价； 4.对出错原因的分析四、经验与教训四、经验与教训3.2 3.2 计算机软件需求说明编制指南计算机软件需求说明编制指南(GB/T 9385-1988)(GB/T 9385-1988)v3.2.1 软件需求文档软件需求文档(SRS)的编制目标的编制目标为客户和开发者之间建立共同协议创立基础提高开发效率为成本计划和进度计划提供基础为确认与验证提供一个基础便于移植作为不断提高的基础3.2 3

17、.2 计算机软件需求说明编制指南计算机软件需求说明编制指南v3.2.2 软件需求文档的基本要求软件需求文档的基本要求必须描述一定的功能与性能必须用确定的方法叙述这些功能、性能（一般不描述任何设计、验证或项目管理的细节问题）3.2 3.2 计算机软件需求说明编制指南计算机软件需求说明编制指南v3.2.3 软件需求标准适用范围软件需求标准适用范围指南适用的对象软件客户、软件开发者指南目的提出规范化的SRS提纲定义自己需要的具体格式和内容产生附加的局部使用条款，如SRS质量检查清单或SRS作者手册指南引用标准GB/T 8566-1988 计算机软件开发规范GB/T 8567-1988 计算机软件产品

18、开发文件编制指南GB/T 11457-1995 软件工程术语有关术语定义合同、客户、语言、分割、开发者、用户“客户”与“用户”的区别3.2 3.2 计算机软件需求说明编制指南计算机软件需求说明编制指南v3.2.4 需求文档的编写大纲需求文档的编写大纲一、前言一、前言 1.目的 2.范围 3.定义、缩写词、略语 4.参考资料；二、项目概述二、项目概述 1.产品描述 2.产品功能 3.用户特点 4.一般约束 5.假设和依据三、具体需求三、具体需求附录索引3.2 3.2 计算机软件需求说明编制指南计算机软件需求说明编制指南三、具体需求 1.功能需求 1）功能需求1 （1）引言 （2）输入 （3）加工

19、 （4）输出 2）功能需求2 n）功能需求n 2.外部接口需求 （1）用户接口 （2）硬件接口 （3）软件接口 （4）通信接口 3.性能需求 4.设计约束 （1）其他标准约束 （2）硬件的限制 5.属性 （1）安全性 （2）可维护性 6.其他需求 （1）数据库 （2）操作 （3）场合适应性 三、具体需求 1.功能需求 1）功能需求1 （1）规格说明 引言 输入 加工 输出 （2）外部接口 用户接口 硬件接口 软件接口 通信接口 2）功能需求2 n）功能需求n 2.性能需求 3.设计约束 （1）其他标准约束 （2）硬件的限制 4.属性 （1）安全性 （2）可维护性 5.其他需求 （1）数据库 （

20、2）操作 （3）场合适应性 3.2 3.2 计算机软件需求说明编制指南计算机软件需求说明编制指南三、具体需求 1.功能需求 1）功能需求1 （1）引言 （2）输入 （3）加工 （4）输出 （5）性能需求 （6）设计约束 其他标准的约束 硬件的限制 （7）属性 安全性 可维护性 （8）其他需求 数据库 操作 场合适应性 2）功能需求2 n）功能需求n 2.外部接口需求 （1）用户接口 （2）硬件接口 （3）软件接口 （4）通信接口三、具体需求 1.功能需求1 （1）引言 （2）输入 （3）加工 （4）输出 （5）外部接口 用户接口 硬件接口 软件接口 通信接口 （6）性能需求 （7）设计约束 （

21、8）属性 安全性 可维护性 （9）其他需求 数据库 操作 场合适应性 2.功能需求2 n.功能需求n3.3 3.3 计算机软件测试文档编制规范计算机软件测试文档编制规范(GB/T 9386-(GB/T 9386-1988)1988)v3.3.1 标准的适用对象及范围标准的适用对象及范围对象：管理人员、开发人员、维护人员、质量保证人员、审计人员、客户及用户范围：着重于动态测试过程，但仍适用其他种类的测试活动应用范围不受软件大小、复杂度或重要性的限制。既适用于软件项目初始阶段，也适用于后期的版本更新活动。并不要求采用特定的测试方法学、技术、设备或工具，对文件控制、配置管理或质量保证既不指明也不强制

22、特定的方法学。3.3 3.3 计算机软件测试文档编制规范计算机软件测试文档编制规范v3.3.2 测试文档的内容测试文档的内容测试计划描述测试活动的范围、方法、资源和进度。规定了被测试的项、被测试的特性、应完成的测试任务、担任各项工作的人员职责及与本计划有关的风险等测试说明测试设计说明详细描述测试方法。测试用例说明列出输入的具体值以及预期的结果，以及各种限制。测试规程说明规定测试的所有步骤。测试报告测试项传递报告测试日志测试事件报告测试总结报告3.3 3.3 计算机软件测试文档编制规范计算机软件测试文档编制规范v3.3.3 测试文档与测试过程测试文档与测试过程软件项目文档是指：源代码、目标代码、

23、作业控制代码、控制数据或以上项目的集合。本规范是对软件产品开发文件指南(GB/T 8567-1988)中涉及的软件测试部分的补充和细化。3.3 3.3 计算机软件测试文档编制规范计算机软件测试文档编制规范v3.3.4 测试文档的结构测试文档的结构1.测试计划1. 测试计划名称2. 引言3. 测试项4. 被测试的特性5. 不被测试的特性6. 方法7. 项通过准则8. 暂停标准和再启动要求9. 应提供的测试文件10. 测试任务11. 环境要求12. 职责13. 人员和训练要求14. 进度15. 风险和应急16. 批准3.3 3.3 计算机软件测试文档编制规范计算机软件测试文档编制规范v3.3.4

24、测试文档的结构测试文档的结构2.测试设计说明3.测试用例说明1. 测试设计说明名称2. 被测试的特性3. 方法详述4. 测试用例名称5. 特性通过准则1. 测试用例说明名称2. 测试项3. 输入说明4. 输出说明5. 环境要求6. 特殊的规程说明7. 用例间的依赖关系黑盒测试的测试用例设计黑盒测试的测试用例设计v划分等价类法划分等价类法有效等价类无效等价类v边界值分析法（等价类法的补充）边界值分析法（等价类法的补充）存在具体边界值，则在值上和非常接近的两边取测试用例。存在输入个数限制，则在个数的边界上设置个数，比最大个数多一个，比最小少一个。v错误推测法错误推测法v因果图法因果图法判定表判定表

25、3.3 3.3 计算机软件测试文档编制规范计算机软件测试文档编制规范v3.3.4 测试文档的结构测试文档的结构4.测试规程说明5.测试项传递报告6.测试日志7.测试事件报告1. 测试规程说明名称2. 目的3. 特殊要求4. 规程步骤1. 传递报告名称2. 传递项3. 位置4. 状态5. 批准1. 测试日志名称2. 描述3. 活动和事件条目1. 测试事件报告名称2. 摘要3. 事件描述4. 影响3.3 3.3 计算机软件测试文档编制规范计算机软件测试文档编制规范v3.3.5 测试文档的编制测试文档的编制设计测试用例最少人力、最少投入、最短时间、尽量减少人为因素。编写测试文档参考附录A每一个具体测

26、试用例都应包含：用例编号用例名称测试等级入口准则验证步骤期望结果（含判断标准）出口准则注释3.3 3.3 计算机软件测试文档编制规范计算机软件测试文档编制规范v3.3.6 测试文档编制实例测试文档编制实例初始阶段可以先编写测试计划与测试报告，经过时间积累之后再逐步引进其他文件。提前写测试报告的用意是什么？3.4 3.4 软件文档管理指南软件文档管理指南 （GB/T 16680-1996GB/T 16680-1996）v3.4.1 软件文档管理概述软件文档管理概述管理者必须关注文档管理涉及的策略、标准、资源和计划。不论项目大小，管理的原则是一致的。对于小项目，可以裁减标准中部分内容以满足特殊需要

27、。文档管理是针对文档编制管理提出的，不涉及文档内容和编排。v3.4.2 软件文档与文档管理者软件文档与文档管理者管理者对文档工作的责任认识到重要性，以及计划、编写、修改、形成、分发和维护各个方面。管理者对文档工作的支持管理者应为编写者提供指导和鼓励，并使用各种有效工具。管理者的主要职责3.4 3.4 软件文档管理指南软件文档管理指南 （GB/T 16680-1996GB/T 16680-1996）v3.4.2 软件文档与文档管理者软件文档与文档管理者管理者的主要职责建立编制、登记、出版系统文档和软件文档的策略。把文档计划作为整个开发工作的一个组成部分。建立确定文档质量、测试质量和评审质量的各种方法。为文档的各个方面确定和准备各种标准和指南。积极支持文档工作以形成自觉编制文档的风气。不断自查，以保证符合策略和规程。项目管理者在项目开发前应决定如下事项：要求哪些类型的文档。提供多少种文档。文档包含的内容。达到何种级别的质量水平。何时产生何种文档。如何保存、维护文档，以及如何进行通信。徐承志徐承志