软件文档国家标准

软件文档
郑州大学信息工程学院
徐婷
1-27
3.3 计算机软件测试文档编制规范
3.3.5 测试文档的编制
1.设计测试用例 测试用例（test case）是指对一项特定的软件产 品进行测试任务的描述，体现测试方案、方法、技术 和策略。内容包括测试目标、测试环境、输入数据、 测试步骤、预期结果、测试脚本等，并形成文档。 不同类型软件，测试用例不同。需要针对软件 产品的功能、业务规则和业务处理，分别对各个开发 阶段的软件产品设计测试用例。可以减少人为因素的 影响。
软件文档
郑州大学信息工程学院
徐婷
1-4
3.2 计算机软件需求规格说明规范
计算机软件需求规格说明规范（GB/T 9385-2008） 为软件需求的实践提供了一个规范化的方法。适用于编 写软件需求规格说明书，它描述了一个软件需求说明书 所必需的内容和质量。 该规范是GB/T9385-1988《计算机软件需求说明编制 指南》的第一次修订。 GB/T9385-1988由原电子工业部 于1988年4月26日批准，1988年12月1日实施。于新标准 实施之日废止。
软件文档
郑州大学信息工程学院
徐婷
1-19
3.3 计算机软件测试文档编制规范
2.测试说明 包括3个文档： （1）测试设计说明 详细描述测试方法，规定该设计及有关测试所包 括的特性，还规定完成测试所需要的测试用例和测试 规程，并规定特性的通过准则。 （2）测试用例说明 列出用于输入的具体值以及预期的输出结果，并 规定在使用具体测试用例时对测试规程的各种限制。 将测试用例和测试设计分开，可以使它们用于多个设 计并能在其他情形下重复使用。
软件文档
郑州大学信息工程学院
徐婷
1-8
3.2 计算机软件需求规格说明规范
5．便于软件产品转移； SRS文档使软件产品转移到新的用户机器更容 易，顾客因此发现软件产品更容易转移到组织的其 他部门，供方发现软件产品更容易转移到新的顾客。 6. 作为进一步增强的基础; 因为SRS文档讨论的是产品而不是开发他的项 目，因此，SRS是已经开发产品后续增强的基础。 尽管SRS文档或许需要修改，但他确实为后续产品 评价提供了基础。
3.3 计算机软件测试文档编制规范
（3）测试事件报告 描述在测试执行期间发生并需要进一步调查的一 切事件。 （4）测试总结报告 总结与测试设计说明有关的测试活动。
软件文档
郑州大学信息工程学院
徐婷
1-23
3.3 计算机软件测试文档编制规范
3.3.3 测试文档与测试过程
描述测试文档与其他文档在编制方面的关系以及 同测试过程的对应关系。 测试文件与测试过程的关系，如下图所示。
徐婷
1-16
3.3 计算机软件测试文档编制规范
3.3.1 标准的适用对象及范围
该规范是为软件管理人员、软件开发、测试和维 护人员、软件质量保证人员、审计人员、客户及用户 制定的。 用于描述一组与软件测试实施方面有关的基本测 试文档，该标准定义每一种基本文档的目的、格式和 内容。尽管标准所描述的文档侧重于动态测试活动， 但是有些文档仍适用于其他种类的测试活动（例如： 测试计划可用于设计和代码评审）。
软件文档 郑州大学信息工程学院 徐婷 1-15
3.3 计算机软件测试文档编制规范
该规范替代了GB/T9386-1988《计算机软件测试 文档编制规范》。原标准由上海计算机技术开发中心 负责起草，由原电子工业部于1988年4月26日批准， 1988年12月1日实施，于新标准实施之日废止。
软件文档
郑州大学信息工程学院
软件文档
郑州大学信息工程学院
徐婷
1-5
3.2 计算机软件需求规格说明规范
3.2.1 软件需求文档的编制目标
SRS Software Requirments Specifications 软件需求说明 SRS对于软件顾客来讲，应尽可能准确地描述其所需 要的产品；而对于供方来讲，应能准确地理解客户所需 要的产品。 其作用可概括以下为6个方面:
软件文档
郑州大学信息工程学院
徐婷
1-20
3.3 计算机软件测试文档编制规范
2.测试说明 （3）测试规程说明 详细说明执行一组测试用例的各个步骤，或者 更广泛的说明为了评估一组特征而用于分析软件项的 各个步骤。 测试规程是与设计分开的，主要明确要遵循的 步骤，而不宜含有无关的细节。
软件文档
郑州大学信息工程学院
软件文档 郑州大学信息工程学院 徐婷 1-18
3.3 计算机软件测试文档编制规范
3.3.2 测试文档的内容
本规范主要定义了3种类型软件测试文档：测试计 划、测试说明和测试报告。 1.测试计划 测试计划描述测试活动的范围、方法、资源和进 度。它规定被测试的项、被测试的特性、应完成的测 试任务、负责每项工作的人员以及与本计划有关的风 险等。
软件文档
郑州大学信息工程学院
徐婷
1-13
3.2 计算机软件需求规格说明规范
3.2.4 需求文档的编写大纲
提纲模板
按照运行模式组织的SRS具体需求模板1、2 按照用户类别组织的SRS具体需求模板 按照对象组织的SRS具体需求模板 按照系统特征组织的SRS具体需求模板 按照激励组织的SRS具体需求模板 按照功能层次组织的SRS具体需求模板 体现多种组织形式的SRS具体需求模板
软件文档 郑州大学信息工程学院 徐婷 1-7
3.2 计算机软件需求规格说明规范
3．为估计成本和进度提供基础； SRS中给出的待开发产品的描述是估计项目成 本的现实基础，可用于取得投标认可或得出价格估 算。
4. 为验证和确认提供基线; 通过一份好的SRS文档，组织可提出更加有效 的验证和确认计划。作为开发合同的一部分，SRS 提供了可用于测量一致性的基线。
软件文档 郑州大学信息工程学院 徐婷 1-10
3.2 计算机软件需求规格说明规范
3.2.3 软件需求标准适用范围
1.适用对象： （1）软件客户，以便精确地描述他们想获得什么 样的产品； （2）软件供方，以便准确地理解客户需要什么样 的产品。 2.目的： （1）要提出开发规范化的SRS提纲； （2）定义自己需要的具体的格式和内容； （3）产生附加的局部条款。
软件文档
郑州大学信息工程学院
徐婷
1-26
3.3 计算机软件测试文档编制规范
3.3.5 测试文档的编制
软件测试文档的内容主要包括测试计划、测试 设计说明书、测试用例说明、测试规程说明、测试项 传递报告、测试日志、测试事件报告以及测试总结报 告8项内容。 需要强调的是，软件测试包括对需求说明书的 测试。因此在软件的需求分析阶段就应开始测试文档 的编制工作，各种测试文档的编写应按一定的格式进 行。
软件文档
郑州大学信息工程学院
徐婷
1-17
3.3 计算机软件测试文档编制规范
3.3.1 标准的适用对象及范围
该标准可应用于数字计算机上运行的商用软件、 科学计算软件或者军用软件。它的应用范围不受软件 大小、复杂度或关键性的限制。本规范既适用于初始 开发的软件测试文件编制，也适用于其后的软件产品 更新版本的测试文档编制。 并不要求采用特定的测试方法学、技术、设备或 工具。对文件控制、配置管理或质量保证既不指明也 不强制特定的wenku.baidu.com法学。根据所用的方法学，可能需要 增加一些其他文档（如“质量保证计划”）。
软件文档
郑州大学信息工程学院
徐婷
1-3
3.1 计算机软件文档编制规范
3.1.1 软件文档的组成 根据该指南，一个计算机软件的开发过程中，一 般应产生14种文档。指南不仅给出了14种文档的编制 指导，同时，也是这14种文档编写质量的检验准则。
3.1.2 各类文档的内容要求 14种文档的内容及要求：详见文档
软件文档
郑州大学信息工程学院
徐婷
1-12
3.2 计算机软件需求规格说明规范
（2）顾客：为产品支付费用，并通常（但不必要） 确定需求的个人或群体，在某些情况下，顾客和供方 可以是同一组织的成员。 （3）供方：为顾客开发产品的个人或群体。在某 些情况下，顾客和供方可以是同一组织的成员。 （4）用户：直接运行系统产品或与产品进行交互 作用的个人或集团。用户和顾客通常不是同一个人或 群体。
徐婷
1-21
3.3 计算机软件测试文档编制规范
3.测试报告 测试报告包括4个文档： （1）测试项传递报告 指明在开发组和测试组独立工作的情况下或在希 望正式开始测试的情况下为进行测试而被传递的测试 项。 （2）测试日志 测试组用于记录测试执行过程中发生的情况。
软件文档
郑州大学信息工程学院
徐婷
1-22
计算机软件文档编制规范（GB/T 8567-2006） 计算机软件需求规格说明规范（GB/T 9385-2008） 计算机软件测试文档编制规范（GB/T 9386-2008） 软件文档管理指南（GB/T 16680-1996）
软件文档
郑州大学信息工程学院
徐婷
1-2
3.1 计算机软件文档编制规范
第3章 软件文档国家标准 3.1 3.2 3.3 3.4 计算机软件产品开发文档编制指南 计算机软件需求说明编制指南 计算机软件测试文档编制规范 软件文档管理指南
软件文档
郑州大学信息工程学院
徐婷
1-1
3.0 软件工程标准
软件工程标准可以分为基础标准、开发标准、 文档标准以及管理标准4种。 我国已经发布的文档标准：
软件文档 郑州大学信息工程学院 徐婷 1-9
3.2 计算机软件需求规格说明规范
3.2.2 软件需求文档的基本要求
SRS是对要完成一定功能、性能的软件产品、程 序或一组程序的说明。因此对SRS的描述有两项基本 要求： 1. 必须描述一定的功能、性能； 2. 必须用确定的方法叙述这些功能。 SRS作为软件开发规范之一，对软件开发的所有 阶段都起着非常重要的作用。但是，需要注意的是： SRS不能超出其作用范围，即除了SRS正确地定义所 有软件的需求之外，一般地SRS不描述任何设计、验 证或项目管理的细节，这是对SRS的另外两个要求。
软件文档
郑州大学信息工程学院
徐婷
1-6
3.2 计算机软件需求规格说明规范
1．对于提供什么软件产品，为顾客和供方之间的 协议建立基础。 SRS中软件功能的完备描述将协助潜在用户， 以便确定指定的软件是否满足其需要，或者为满足 其需要应如何定义该软件。 2. 减少开发工作; SRS文档的编制迫使顾客组织有关各方面人员 在设计之前严格考虑所有的需求，并减少以后的重 新设计、重新编码和重新测试。对SRS中的各项需 求进行仔细评审，可以在开发周期的早期揭示某些 遗漏、误解和不一致，此时问题更容易纠正。
软件文档 郑州大学信息工程学院 徐婷 1-11
3.2 计算机软件需求规格说明规范
3.指南引用标准： （1）GB/T 8566-2007信息技术—软件生存周期过程 （2）GB/T 11457-2006信息技术—软件工程术语。
4.有关定义： （1）合同：是顾客和供方共同签署的具体有法律约 束力的文件。其中包括产品的技术、组织、成本和进 度计划要求等内容。
计算机软件文档编制规范（GB/T 8567-2006） 是指导性文档。该标准是GB/T8567—1988《计算机软 件产品开发文件编制指南》的修订版，并改名为《计 算机软件文档编制规范》。并从实施之日起代替 GB/T8567—1988。 GB/T 8567-1988由原电子工业部提出，中国软件 技术公司负责起草， 国家标准局于1988年1月7日批准， 1988年7月1日实施。于新标准实施之日废止。
软件文档
郑州大学信息工程学院
徐婷
1-24
测试文件与 测试过程的 关系
软件文档
郑州大学信息工程学院
徐婷
1-25
3.3 计算机软件测试文档编制规范
3.3.4 测试文档的结构
共8个文档：
1. 2. 3. 4. 5. 6. 7. 8. 测试计划 测试设计说明 测试用例说明 测试规程说明 测试项传递报告 测试日志 测试事件报告 测试总结报告
3.2.5 需求文档的编制说明
软件文档 郑州大学信息工程学院 徐婷 1-14
3.3 计算机软件测试文档编制规范
测试是软件生存周期中一个独立的、关键的阶段， 也是保证软件质量的重要手段。为了提高检测出错的 几率，使测试能有计划、有条不紊地进行，就必须编 制测试文档。而标准化测试文档就如同一种通用的参 照体系，可达到便于交流的目的。 计算机软件测试文档编制规范（GB/T 9386-2008） 的目的就是规定一组软件测试文档，定义每一种基本 文档的目的、格式和内容。测试文档中所规定的内容 可以作为对测试过程完备性的对照检查表，这将会提 高测试过程的每个阶段的能见度，极大地提高测试工 作的可管理性。