软件文档国家标准

第3章软件文档国家标准 3 1计算机软件产品开发文档编制指南3 2计算机软件需求说明编制指南3 3计算机软件测试文档编制规范3 4软件文档管理指南 3 0软件工程标准 软件工程标准可以分为基础标准 开发标准 文档标准以及管理标准4种 我国已经发布的文档标准 计算机软件文档编制规范 GB T8567 2006 计算机软件需求规格说明规范 GB T9385 2008 计算机软件测试文档编制规范 GB T9386 2008 软件文档管理指南 GB T16680 1996 3 1计算机软件文档编制规范 计算机软件文档编制规范 GB T8567 2006 是指导性文档 该标准是GB T8567 1988 计算机软件产品开发文件编制指南 的修订版 并改名为 计算机软件文档编制规范 并从实施之日起代替GB T8567 1988 GB T8567 1988由原电子工业部提出 中国软件技术公司负责起草 国家标准局于1988年1月7日批准 1988年7月1日实施 于新标准实施之日废止 3 1 1软件文档的组成根据该指南 一个计算机软件的开发过程中 一般应产生14种文档 指南不仅给出了14种文档的编制指导 同时 也是这14种文档编写质量的检验准则 3 1 2各类文档的内容要求14种文档的内容及要求 详见文档 3 1计算机软件文档编制规范 3 2计算机软件需求规格说明规范 计算机软件需求规格说明规范 GB T9385 2008 为软件需求的实践提供了一个规范化的方法 适用于编写软件需求规格说明书 它描述了一个软件需求说明书所必需的内容和质量 该规范是GB T9385 1988 计算机软件需求说明编制指南 的第一次修订 GB T9385 1988由原电子工业部于1988年4月26日批准 1988年12月1日实施 于新标准实施之日废止 3 2 1软件需求文档的编制目标SRSSoftwareRequirmentsSpecifications软件需求说明SRS对于软件顾客来讲 应尽可能准确地描述其所需要的产品 而对于供方来讲 应能准确地理解客户所需要的产品 其作用可概括以下为6个方面 3 2计算机软件需求规格说明规范 1 对于提供什么软件产品 为顾客和供方之间的协议建立基础 SRS中软件功能的完备描述将协助潜在用户 以便确定指定的软件是否满足其需要 或者为满足其需要应如何定义该软件 2 减少开发工作 SRS文档的编制迫使顾客组织有关各方面人员在设计之前严格考虑所有的需求 并减少以后的重新设计 重新编码和重新测试 对SRS中的各项需求进行仔细评审 可以在开发周期的早期揭示某些遗漏 误解和不一致 此时问题更容易纠正 3 2计算机软件需求规格说明规范 3 为估计成本和进度提供基础 SRS中给出的待开发产品的描述是估计项目成本的现实基础 可用于取得投标认可或得出价格估算 4 为验证和确认提供基线 通过一份好的SRS文档 组织可提出更加有效的验证和确认计划 作为开发合同的一部分 SRS提供了可用于测量一致性的基线 3 2计算机软件需求规格说明规范 5 便于软件产品转移 SRS文档使软件产品转移到新的用户机器更容易 顾客因此发现软件产品更容易转移到组织的其他部门 供方发现软件产品更容易转移到新的顾客 6 作为进一步增强的基础 因为SRS文档讨论的是产品而不是开发他的项目 因此 SRS是已经开发产品后续增强的基础 尽管SRS文档或许需要修改 但他确实为后续产品评价提供了基础 3 2计算机软件需求规格说明规范 3 2 2软件需求文档的基本要求SRS是对要完成一定功能 性能的软件产品 程序或一组程序的说明 因此对SRS的描述有两项基本要求 1 必须描述一定的功能 性能 2 必须用确定的方法叙述这些功能 SRS作为软件开发规范之一 对软件开发的所有阶段都起着非常重要的作用 但是 需要注意的是 SRS不能超出其作用范围 即除了SRS正确地定义所有软件的需求之外 一般地SRS不描述任何设计 验证或项目管理的细节 这是对SRS的另外两个要求 3 2计算机软件需求规格说明规范 3 2 3软件需求标准适用范围1 适用对象 1 软件客户 以便精确地描述他们想获得什么样的产品 2 软件供方 以便准确地理解客户需要什么样的产品 2 目的 1 要提出开发规范化的SRS提纲 2 定义自己需要的具体的格式和内容 3 产生附加的局部条款 3 2计算机软件需求规格说明规范 3 指南引用标准 1 GB T8566 2007信息技术 软件生存周期过程 2 GB T11457 2006信息技术 软件工程术语 4 有关定义 1 合同 是顾客和供方共同签署的具体有法律约束力的文件 其中包括产品的技术 组织 成本和进度计划要求等内容 3 2计算机软件需求规格说明规范 2 顾客 为产品支付费用 并通常 但不必要 确定需求的个人或群体 在某些情况下 顾客和供方可以是同一组织的成员 3 供方 为顾客开发产品的个人或群体 在某些情况下 顾客和供方可以是同一组织的成员 4 用户 直接运行系统产品或与产品进行交互作用的个人或集团 用户和顾客通常不是同一个人或群体 3 2计算机软件需求规格说明规范 3 2 4需求文档的编写大纲提纲模板按照运行模式组织的SRS具体需求模板1 2按照用户类别组织的SRS具体需求模板按照对象组织的SRS具体需求模板按照系统特征组织的SRS具体需求模板按照激励组织的SRS具体需求模板按照功能层次组织的SRS具体需求模板体现多种组织形式的SRS具体需求模板3 2 5需求文档的编制说明 3 2计算机软件需求规格说明规范 3 3计算机软件测试文档编制规范 测试是软件生存周期中一个独立的 关键的阶段 也是保证软件质量的重要手段 为了提高检测出错的几率 使测试能有计划 有条不紊地进行 就必须编制测试文档 而标准化测试文档就如同一种通用的参照体系 可达到便于交流的目的 计算机软件测试文档编制规范 GB T9386 2008 的目的就是规定一组软件测试文档 定义每一种基本文档的目的 格式和内容 测试文档中所规定的内容可以作为对测试过程完备性的对照检查表 这将会提高测试过程的每个阶段的能见度 极大地提高测试工作的可管理性 3 3计算机软件测试文档编制规范 该规范替代了GB T9386 1988 计算机软件测试文档编制规范 原标准由上海计算机技术开发中心负责起草 由原电子工业部于1988年4月26日批准 1988年12月1日实施 于新标准实施之日废止 3 3 1标准的适用对象及范围该规范是为软件管理人员 软件开发 测试和维护人员 软件质量保证人员 审计人员 客户及用户制定的 用于描述一组与软件测试实施方面有关的基本测试文档 该标准定义每一种基本文档的目的 格式和内容 尽管标准所描述的文档侧重于动态测试活动 但是有些文档仍适用于其他种类的测试活动 例如 测试计划可用于设计和代码评审 3 3计算机软件测试文档编制规范 3 3 1标准的适用对象及范围该标准可应用于数字计算机上运行的商用软件 科学计算软件或者军用软件 它的应用范围不受软件大小 复杂度或关键性的限制 本规范既适用于初始开发的软件测试文件编制 也适用于其后的软件产品更新版本的测试文档编制 并不要求采用特定的测试方法学 技术 设备或工具 对文件控制 配置管理或质量保证既不指明也不强制特定的方法学 根据所用的方法学 可能需要增加一些其他文档 如 质量保证计划 3 3计算机软件测试文档编制规范 3 3 2测试文档的内容本规范主要定义了3种类型软件测试文档 测试计划 测试说明和测试报告 1 测试计划测试计划描述测试活动的范围 方法 资源和进度 它规定被测试的项 被测试的特性 应完成的测试任务 负责每项工作的人员以及与本计划有关的风险等 3 3计算机软件测试文档编制规范 2 测试说明包括3个文档 1 测试设计说明详细描述测试方法 规定该设计及有关测试所包括的特性 还规定完成测试所需要的测试用例和测试规程 并规定特性的通过准则 2 测试用例说明列出用于输入的具体值以及预期的输出结果 并规定在使用具体测试用例时对测试规程的各种限制 将测试用例和测试设计分开 可以使它们用于多个设计并能在其他情形下重复使用 3 3计算机软件测试文档编制规范 2 测试说明 3 测试规程说明详细说明执行一组测试用例的各个步骤 或者更广泛的说明为了评估一组特征而用于分析软件项的各个步骤 测试规程是与设计分开的 主要明确要遵循的步骤 而不宜含有无关的细节 3 3计算机软件测试文档编制规范 3 测试报告测试报告包括4个文档 1 测试项传递报告指明在开发组和测试组独立工作的情况下或在希望正式开始测试的情况下为进行测试而被传递的测试项 2 测试日志测试组用于记录测试执行过程中发生的情况 3 3计算机软件测试文档编制规范 3 测试事件报告描述在测试执行期间发生并需要进一步调查的一切事件 4 测试总结报告总结与测试设计说明有关的测试活动 3 3计算机软件测试文档编制规范 3 3 3测试文档与测试过程描述测试文档与其他文档在编制方面的关系以及同测试过程的对应关系 测试文件与测试过程的关系 如下图所示 3 3计算机软件测试文档编制规范 测试文件与测试过程的关系 3 3 4测试文档的结构共8个文档 测试计划测试设计说明测试用例说明测试规程说明测试项传递报告测试日志测试事件报告测试总结报告 3 3计算机软件测试文档编制规范 3 3 5测试文档的编制软件测试文档的内容主要包括测试计划 测试设计说明书 测试用例说明 测试规程说明 测试项传递报告 测试日志 测试事件报告以及测试总结报告8项内容 需要强调的是 软件测试包括对需求说明书的测试 因此在软件的需求分析阶段就应开始测试文档的编制工作 各种测试文档的编写应按一定的格式进行 3 3计算机软件测试文档编制规范 3 3 5测试文档的编制1 设计测试用例测试用例 testcase 是指对一项特定的软件产品进行测试任务的描述 体现测试方案 方法 技术和策略 内容包括测试目标 测试环境 输入数据 测试步骤 预期结果 测试脚本等 并形成文档 不同类型软件 测试用例不同 需要针对软件产品的功能 业务规则和业务处理 分别对各个开发阶段的软件产品设计测试用例 可以减少人为因素的影响 3 3计算机软件测试文档编制规范 3 3 5测试文档的编制2 编写测试文档测试文档主要由若干测试用例组成 各种测试文档的编写应按照文档模板 按一定的格式进行 编写时可参考 计算机软件文档编制规范 测试文档由简介和测试用例两部分组成 3 3计算机软件测试文档编制规范 3 3 6测试文档的编制实例在实施测试文件编制的初级阶段可先编写测试计划与测试报告文件 测试计划将为整个测试过程提供基础 测试报告将鼓励测试单位以良好的方式记录整个测试过程的情况 经过一段时间的实践 积累了一定经验后再逐步引进其他文件 测试文件编制最终将形成一个相应于设计层的文件层次 即系统测试文件 子系统测试文件及模块测试文件等 在本单位所使用的特定的测试技术的文件编制可作为正文中所述的基本文件集的补充 3 3计算机软件测试文档编制规范 3 3 6测试文档的编制实例在项目计划及单位标准中 应该指明在哪些测试报告中需要哪些测试文件 并可在文件中加入一些内容 使各个文件适应一个特定的测试项及一个特定的测试环境 一个测试文件编制实例 3 3计算机软件测试文档编制规范 软件文档管理指南 GB T16680 1996 是为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南 其目的在于协助管理者在他们的机构中产生有效的文档 3 4软件文档管理指南 3 4 1软件文档管理概述软件文档管理涉及策略 标准 规程 资源和计划 管理者必须关注这些内容 以便有效地管理软件文档 软件文档管理期望应用于各种类型软件 简单 复杂 并期望覆盖各种类型的软件文档 作用于软件生存期的各个阶段 不论项目大小 软件文档管理的原则是一致的 软件文档管理是针对文档编制管理而提出的 不涉及软件文档的内容和编排 3 4软件文档管理指南 3 4 2软件文档与文档管理者管理者应严格要求软件开发人员和编制组完成文档编制 并且在策略 标准 规程 资源分配和编制计划方面给予支持 主要作用包括三个方面 1 管理者对文档工作的责任管理者要认识到正式或非正式文档都是重要的 还要认识到文档工作必须包括文档计划 编写 修改 形成 分发和维护等各个方面 2 管理者对文档工作的支持管理者应为编写文档的人员提供指导和实际鼓励 并使各种资源有效地用于文档开发 3 4软件文档管理指南 3 4 2软件文档与文档管理者3 管理者的主要职责 1 承担的职责建立编制 登记 出版系统文档和软件文档的各种策略 把文档计划作为整个开发工作的一个组成部分 建立确定文档质量 测试质量和评审质