软件设计国家标准-文档

操作手册（GB8567——88）1引言1.1编写目的说明编写这份操作手册的目的，指出预期的读者。1.2前景说明：a．这份操作手册所描述的软件系统的名称；b．该软件项目的任务提出者、开发者、用户（或首批用户）及安装该软件的计算中心。1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4参考资料列出有用的参考资料，如：a．本项目的经核准的计划任务书或合同、上级机关的批文；b．属于本项目的其他已发表的文件；c．本文件中各处引用的文件、资料，包括所列出的这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。2软件征述2.1软件的结构结合软件系统所具有的功能包括输入、处理和输出提供该软件的总体结构图表。2.2程序表列出本系统内每个程序的标识符、编号和助记名。2.3文卷表列出将由本系统引用、建立或更新的每个永久性文卷，说明它们各自的标识符、编号、助记名、存储媒体和存储要求。3安装与初始化一步一步地说明为使用本软件而需要进行的安装与初始化过程，包括程序的存载形式，安装与初始化过程中的全部操作命令，系统对这些命令的反应与答复，表征安装工作完成的测试实例等。如果有的话，还应说明安装过程中所需用到的专用软件。4运行说明所谓一个运行是指提供一个启动控制信息后，直到计算机系统等待另一个启动控制信息时为止的计算机系统执行的全部过程。4.1运行表列出每种可能的运行，摘要说明每个运行的目的，指出每个运行各自所执行的程序。4.2运行步骤说明从一个运行转向另一个运行以完成整个系统运行的步骤。4.3运行1（标识符）说明把运行1的有关信息，以对操作人员为最方便最有用的形式加以说明。4.3.1运行控制列出为本运行所需要”的运行流向控制的说明。4.3.2操作信息给出为操作中心的操作人员和管理人员所需要的信息，如：a.运行目的；b.操作要求；c.启动方法如应请启动（由所遇到的请求信息启动）、预定时间启动、…，··等；d.预计的运行时间和解题时间；e.操作命令；f.与运行有联系的其他事项。4.3.3输入一输出文卷提供被本运行建立、更新或访问的数据文卷的有关信息，如：a.文卷的标识符或标号；b.记录媒体；c.存留的目录表；d.文卷的支配如确定保留或废弃的准则、是否要分配给其他接受者、占用硬设备的优先级以及保密控制等有关规定。4.3.4输出文段提供本软件输出的每一一个用于提示、说明、或应答的文段（包括“菜单”）的有关信息，如：a.文段的标识符；b.输出媒体（屏幕显示、打印、……）；c.文字容量；d.分发对象；e.保密要求。4.3.5输出文段的复制对由计算机产生，而后需用其他方法复制的那些文段提供有关信息，如：a.文段的标识符；b.复制的技术手段；c.纸张或其他媒体的规格；d.装订要求；e.分发对象；f.复制份数。4.3.6恢复过程说明本运行故障后的恢复过程。4.4运行2（标识符）说明用与本手册4.3条相类似的方式介绍另一个运行的有关信息。5非常规过程提供有关应急操作或非常规操作的必要信息，如出错处理操作、向后备系统的切换操作以及其他必须向程序维护人员交待的事项和步骤。6远程操作如果本软件能够通过远程终端控制运行，则在本章说明通过远程终端运行本软件的操作过程。测试分析报告（GB8567——88）1引言1.1编写目的说明这份测试分析报告的具体编写目的，指出预期的阅读范围。1.2背景说明：a.被测试软件系统的名称；b.该软件的任务提出者、开发者、用户及安装此软件的计算中心，指出测试环境与实际运行环境之间可能存在的差异以及这些差异对测试结果的影响。1.3定义列出本文件中用到的专问术语的定义和外文首字母组词的原词组。1.4参考资料列出要用到的参考资料，如：a．本项目的经核准的计划任务书或合同、上级机关的批文；b．属于本项目的其他已发表的文件；c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。2测试概要用表格的形式列出每一项测试的标识符及其测试内容，并指明实际进行的测试工作内容与测试计划中预先设计的内容之间的差别，说明作出这种改变的原因。3测试结果及发现3.1测试1（标识符）把本项测试中实际得到的动态输出（包括内部生成数据输出）结果同对于动态输出的要求进行比较，陈述其中的各项发现。3.2测试2（标识符）用类似本报告3.1条的方式给出第2项及其后各项测试内容的测试结果和发现。4对软件功能的结论4.1功能1（标识符）4.1.1能力简述该项功能，说明为满足此项功能而设计的软件能力以及经过一项或多项测试已证实的能力。4.1.2限制说明测试数据值的范围（包括动态数据和静态数据），列出就这项功能而言，测试期间在该软件中查出的缺陷、局限性。4.2功能2（标识符）用类似本报告4.l的方式给出第2项及其后各项功能的测试结论。．．．．5分析摘要5.1能力陈述经测试证实了的本软件的能力。如果所进行的测试是为了验证一项或几项特定性能要求的实现，应提供这方面的测试结果与要求之间的比较，并确定测试环境与实际运行环境之间可能存在的差异对能力的测试所带来的影响。5.2缺陷和限制陈述经测试证实的软件缺陷和限制，说明每项缺陷和限制对软件性能的影响，并说明全部测得的性能缺陷的累积影响和总影响。5.3建议对每项缺陷提出改进建议，如：a．各项修改可采用的修改方法；b．各项修改的紧迫程度；c．各项修改预计的工作量；d．各项修改的负责人。5.4评价说明该项软件的开发是否已达到预定目标，能否交付使用。6测试资源消耗总结测试工作的资源消耗数据，如工作人员的水平级别数量、机时消耗等。测试计划（GB8567——88）1引言1.1编写目的本测试计划的具体编写目的，指出预期的读者范围。1.2背景说明：a．测试计划所从属的软件系统的名称；b．该开发项目的历史，列出用户和执行此项目测试的计算中心，说明在开始执行本测试计划之前必须完成的各项工作。1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4参考资料列出要用到的参考资料，如：a．本项目的经核准的计划任务书或合同、上级机关的批文；b．属于本项目的其他已发表的文件；c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。2计划2.1软件说明提供一份图表，并逐项说明被测软件的功能、输入和输出等质量指标，作为叙述测试计划的提纲。2.2测试内容列出组装测试和确认测试中的每一项测试内容的名称标识符、这些测试的进度安排以及这些测试的内容和目的，例如模块功能测试、接口正确性测试、数据文卷存取的测试、运行时间的测试、设计约束和极限的测试等。2.3测试1（标识符）给出这项测试内容的参与单位及被测试的部位。2.3.1进度安排给出对这项测试的进度安排，包括进行测试的日期和工作内容（如熟悉环境。培训、准备输入数据等）。2.3.2条件陈述本项测试工作对资源的要求，包括：a．设备所用到的设备类型、数量和预定使用时间；b．软件列出将被用来支持本项测试过程而本身又并不是被测软件的组成部分的软件，如测试驱动程序、测试监控程序、仿真程序、桩模块等等；c．人员列出在测试工作期间预期可由用户和开发任务组提供的工作人员的人数。技术水平及有关的预备知识，包括一些特殊要求，如倒班操作和数据键入人员。2.3.3测试资料列出本项测试所需的资料，如：a．有关本项任务的文件；b．被测试程序及其所在的媒体；c．测试的输入和输出举例；d．有关控制此项测试的方法、过程的图表。2.3.4测试培训说明或引用资料说明为被测软件的使用提供培训的计划。规定培训的内容、受训的人员及从事培训的工作人员。2.4测试2（标识符）用与本测试计划2.3条相类似的方式说明用于另一项及其后各项测试内容的测试工作计划。3测试设计说明3.1测试1（标识符）说明对第一项测试内容的测试设计考虑。3.1.1控制说明本测试的控制方式，如输入是人工、半自动或自动引入、控制操作的顺序以及结果的记录方法。3.1.2输入说明本项测试中所使用的输入数据及选择这些输入数据的策略。3.1.3输出说明预期的输出数据，如测试结果及可能产生的中间结果或运行信息。3.1.4过程说明完成此项测试的一个个步骤和控制命令，包括测试的准备、初始化、中间步聚和运行结束方式。3.2测试2（标识符）用与本测试计划3.l条相类似的方式说明第2项及其后各项测试工作的设计考虑。4评价准则4.1范围说明所选择的测试用例能够接查的范围及其局限性。4.2数据整理陈述为了把测试数据加工成便于评价的适当形式，使得测试结果可以同，已知结果进行比较而要用到的转换处理技术，如手工方式或自动方式；如果是用自动方式整理数据，还要说明为进行处理而要用到的硬件、软件资源。4.3尺度说明用来判断测试工作是否能通过的评价尺度，如合理的输出结果的类型、测试输出结果与预期输出之间的容许偏离范围、允许中断或停机的最大次数。概要设计说明书（GB8567——88）1引言1.1编写目的说明编写这份概要设计说明书的目的，指出预期的读者。1.2背景说明：a.待开发软件系统的名称；b.列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站（中心）。1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4参考资料列出有关的参考文件，如：a.本项目的经核准的计划任务书或合同，上级机关的批文；b.属于本项目的其他已发表文件；c.本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。2总体设计2.1需求规定说明对本系统的主要的输入输出项目、处理的功能性能要求，详细的说明可参见附录C。2.2运行环境简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定，详细说明参见附录C。2.3基本设计概念和处理流程说明本系统的基本设计概念和处理流程，尽量使用图表的形式。2.4结构用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系.2.5功能器求与程序的关系本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系：程序1程序2……程序n功能需求1√功能需求2√……功能需求n√√2.6人工处理过程说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。2.7尚未问决的问题说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。3接口设计3.1用户接口说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。3.2外部接口说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。3.3内部接口说明本系统之内的各个系统元素之间的接口的安排。4运行设计4.1运行模块组合说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。4.2运行控制说明每一种外界的运行控制的方式方法和操作步骤。4.3运行时间说明每种运行模块组合将占用各种资源的时间。5系统数据结构设计5.1逻辑结构设计要点给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。5.2物理结构设计要点给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。5.3数据结构与程序的关系说明各个数据结构与访问这些数据结构的形式:6系统出错处理设计6.1出错信息用一览表的方式说朗每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。6.2补救措施说明故障出现后可能采取的变通措施，包括：a.后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁