软件设计国家标准文档

操作手册（GB856788）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远程操作如果本软件能够通过远程终端控制运行，则在本章说明通过远程终端运行本软件的操作过程。测试分析报告（GB856788）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测试资源消耗总结测试工作的资源消耗数据，如工作人员的水平级别数量、机时消耗等。测试计划（GB856788）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尺度说明用来判断测试工作是否能通过的评价尺度，如合理的输出结果的类型、测试输出结果与预期输出之间的容许偏离范围、允许中断或停机的最大次数。概要设计说明书（GB856788）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功能需求n2.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.后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术；b.降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录；c.恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。6.3系统维护设计说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。各个程序之间的对应关系，可采用如下的矩阵图的形式；开发进度月报（GB856788）1、标题开发中的软件系统的名称和标识符分项目名称和标识符分项目负责人签名本期月报编写人签名本期月报的编号及所报告的年月2、工程进度与状态2.1进度列出本月内进行的各项主要活动，并且说明本月内遇到的重要事件，这里所说的重要事件是指一个开发阶段（即软件生存周期内各个阶段中的某一个，例如需求分析阶段）的开始或结束，要说明阶段名称及开始（或结束）的日期。2.2状态说明本月的实际工作进度与计划相比，是提前了、按期完成了、或是推迟了？如果与计划不一致，说明原因及准备采取的措施。3资额耗用与状态3.1资额耗用主要说明本月份内耗用的工时与机时。3.1.1工时分为三类：a管理用工时包括在项目管理（制订计划、布置工作、收集数据、检查汇报工作等）方面耗用的工时；b服务工时包括为支持项目开发所必须的服务工作及非直接的开发工作所耗用的工时；c开发用工时要分各个开发阶段填写。3.1.2机时说明本月内耗用的机时，以小时为单位，说明计算机系统的型号。3.2状态说明本月内实际耗用的资源与计划相比，是超出了、相一致、还是不到计划数？如果与计划不一致，说明原因及准备采取的措施。4经费支出与状态4.1经费支出4.1.1支持性费用列出本月内支出的支持性费用，一般可按如下七类列出，并给出本月支持费用的总和：a.房租或房屋折旧费；b.社工资、奖金、补贴；c.培训费包括给教师的酬金及教室租金；d.资料费包括复印及购买参考资料的费用；e.会议费召集有关业务会议的费用；f.旅差费；g.其他费用。4.1.2设备购置费列出本月内支出的设备购置费，一般可分如下三类：a购买软件的名称与金额；b购买硬设备的名称、型号、数量及金额；c已有硬设备的折旧费。4.2状态说明本月内实际支出的经费与计划相比较，是超过了。相符合、还是不到计划数？如果与计划不一致，说明原因及准备采取的措施。5下个月的工作计划6建议本月遇到的重要问题和应引起重视的问题以及因此产生的建议。可行性研究报告GB8567881引言1.1编写目的说明编写本可行性研究报告的目的，指出预期的读者。1.2背景说明：A.所建议开发的软件系统的名称；B.本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络；C. 该软件系统同其他系统或其他机构的基本的相互来往关系。1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4参考资料列出用得着的参考资料，如：1.本项目的经核准的计划任务书或合同、上级机关的批文；2.属于本项目的其他已发表的文件；3.本文件中各处引用的文件、资料，包括所需用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。2、可行性研究的前提说明对所建议的开发项目进行可行性研究的前提，如要求、目标、假定、限制等。2.1要求说明对所建议开发的软件的基本要求，如：A.功能；B.性能；C.输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象；D.输入说明系统的输入，包括数据的来源、类型、数量、数据的组织以及提供的频度；E.处理流程和数据流程用图表的方式表示出最基本的数据流程和处理流程辅之以叙述；F.在安全与保密方面的要求；G.同本系统相连接的其他系统；H.完成期限。2.2目标说明所建议系统的主要开发目标，如：A.人力与设备费用的减少；B.处理速度的提高；C.控制精度或生产能力的提高；D.管理信息服务的改进；E.自动决策系统的改进；F.人员利用率的改进。2.3条件、假定和限制说明对这项开发中给出的条件、假定和所受到的限制，如：a 所建议系统的运行寿命的最小值；b进行系统方案选择比较的时间；c 经费、投资方面的来源和限制；d法律和政策方面的限制；e 硬件、软件、运行环境和开发环境方面的条件和限制；f可利用的信息和资源；g 系统投入使用的最晚时间。2.4进行可行性研究的方法说明这项可行性研究将是如何进行的，所建议的系统将是如何评价的。摘要说明所使用的基本方法和策略，如调查、加权、确定模型、建立基准点或仿真等。2.5评价尺度说明对系统进行评价时所使用的主要尺度，如费用的多少、各项功能的优先次序、开发时间的长短及使用中的难易程度。3对现有系统的分析这里的现有系统是指当前实际使用的系统，这个系统可能是计算机系统，也可能是一个机械系统甚至是一个人工系统。分析现有系统的目的是为了进一步阐明建议中的开发新系统或修改现有系统的必要性。3.1处理流程和数据流程说明现有系统的基本的处理流程和数据流程。此流程可用图表即流程图的形式表示，并加以叙述。3.2工作负荷列出现有系统所承担的工作及工作量。3.3费用开支列出由于运行现有系统所引起的费用开支，如人力、设备、空间、支持性服务、材料等项开支以及开支总额。3.4人员列出为了现有系统的运行和维护所需要的人员的专业技术类别和数量。3.5设备列出现有系统所使用的各种设备。3.6局限性列出本系统的主要的局限性，例如处理时间赶不上需要，响应不及时，数据存储能力不足，处理功能不够等。并且要说明，为什么对现有系统的改进性维护已经不能解决问题。4所建议的系统本章将用来说明所建议系统的目标和要求将如何被满足。4.1对所建议系统的说明概括地说明所建议系统，并说明在第2章中列出的那些要求将如何得到满足，说明所使用的基本方法及理论根据。4.2处理流程和数据流程给出所建议系统的处理流程和数据流程。4.3改进之处按2.2条中列出的目标，逐项说明所建议系统相对于现存系统具有的改进。4.4影响说明在建立所建议系统时，预期将带来的影响，包括：4.4.1对设备的影响说明新提出的设备要求及对现存系统中尚可使用的设备须作出的修改。4.4.2对软件的影响说明为了使现存的应用软件和支持软件能够同所建议系统相适应。而需要对这些软件所进行的修改和补充。4.4.3对用户单位机构的影响说明为了建立和运行所建议系统，对用户单位机构、人员的数量和技术水平等方面的全部要求。4.4.4对系统运行过程的影响说明所建议系统对运行过程的影响，如：a 用户的操作规程；b运行中心的操作规程；c 运行中心与用户之间的关系；d源数据的处理；e 数据进入系统的过程；f对数据保存的要求，对数据存储、恢复的处理；g 输出报告的处理过程、存储媒体和调度方法；h 系统失效的后果及恢复的处理办法。4.4.5对开发的影响说明对开发的影响，如：a.为了支持所建议系统的开发，用户需进行的工作；b.为了建立一个数据库所要求的数据资源；c.为了开发和测验所建议系统而需要的计算机资源；d.所涉及的保密与安全问题。4.4.6对地点和设施的影响说明对建筑物改造的要求及对环境设施的要求。4.4.7对经费开支的影响扼要说明为了所建议系统的开发，设计和维持运行而需要的各项经费开支。4.5局限性说明所建议系统尚存在的局限性以及这些问题未能消除的原因。4.6技术条件方面的可行性本节应说明技术条件方面的可行性，如：a 在当前的限制条件下，该系统的功能目标能否达到；b利用现有的技术，该系统的功能能否实现；c 对开发人员的数量和质量的要求并说明这些要求能否满足；d在规定的期限内，本系统的开发能否完成。5可选择的其他系统方案扼要说明曾考虑过的每一种可选择的系统方案，包括需开发的和可从国内国外直接购买的，如果没有供选择的系统方案可考虑，则说明这一点。5.1可选择的系统方案1参照第4章的提纲，说明可选择的系统方案1，并说明它未被选中的理由。5.2可选择的系统方案2按类似5.1条的方式说明第2个乃至第n个可选择的系统方案。.6投资及效益分析6.1支出对于所选择的方案，说明所需的费用。如果已有一个现存系统，则包括该系统继续运行期间所需的费用。6.1.1基本建设投资包括采购、开发和安装下列各项所需的费用，如：a.房屋和设施；b.ADP设备；c.数据通讯设备；d.环境保护设备；e.安全与保密设备；f.ADP操作系统的和应用的软件；g.数据库管理软件。6.1.2其他一次性支出包括下列各项所需的费用，如：a 研究（需求的研究和设计的研究）；b开发计划与测量基准的研究；c 数据库的建立；dADP软件的转换；e 检查费用和技术管理性费用；f培训费、旅差费以及开发安装人员所需要的一次性支出；g 人员的退休及调动费用等。6.1.3非一次性支出列出在该系统生命期内按月或按季或按年支出的用于运行和维护的费用，包括：a 设备的租金和维护费用；b软件的租金和维护费用；c 数据通讯方面的租金和维护费用；d人员的工资、奖金；e 房屋、空间的使用开支；f公用设施方面的开支；g 保密安全方面的开支；h 其他经常性的支出等。6.2收益对于所选择的方案，说明能够带来的收益，这里所说的收益，表现为开支费用的减少或避免、差错的减少、灵活性的增加、动作速度的提高和管理计划方面的改进等，包括；6.2.1一次性收益说明能够用人民币数目表示的一次性收益，可按数据处理、用户、管理和支持等项分类叙述，如：a 开支的缩减包括改进了的系统的运行所引起的开支缩减，如资源要求的减少，运行效率的改进，数据进入、存贮和恢复技术的改进，系统性能的可监控，软件的转换和优化，数据压缩技术的采用，处理的集中化分布化等；b价值的增升包括由于一个应用系统的使用价值的增升所引起的收益，如资源利用的改进，管理和运行效率的改进以及出错率的减少等；c 其他如从多余设备出售回收的收入等。6.2.2非一次性收益说明在整个系统生命期内由于运行所建议系统而导致的按月的、按年的能用人民币数目表示的收益，包括开支的减少和避免。6.2.3不可定量的收益逐项列出无法直接用人民币表示的收益，如服务的改进，由操作失误引起的风险的减少，信息掌握情况的改进，组织机构给外界形象的改善等。有些不可捉摸的收益只能大概估计或进行极值估计（按最好和最差情况估计）。6.3收益投资比求出整个系统生命期的收益投资比值。6.4投资回收周期求出收益的累计数开始超过支出的累计数的时间。6.5敏感性分析所谓敏感性分析是指一些关键性因素如系统生命期长度、系统的工作负荷量、工作负荷的类型与这些不同类型之间的合理搭配、处理速度要求、设备和软件的配置等变化时，对开支和收益的影响最灵敏的范围的估计。在敏感性分析的基础上做出的选择当然会比单一选择的结果要好一些。7社会因素方面的可行性本章用来说明对社会因素方面的可行性分析的结果，包括：7.1法律方面的可行性法律方面的可行性问题很多，如合同责任、侵犯专利权、侵犯版权等方面的陷井，软件人员通常是不熟悉的，有可能陷入，务必要注意研究。7.2使用方面的可行性例如从用户单位的行政管理、工作制度等方面来看，是否能够使用该软件系统；从用户单位的工作人员的素质来看，是否能满足使用该软件系统的要求等等，都是要考虑的。8结论在进行可行性研究报告的编制时，必须有一个研究的结论。结论可以是：a 可以立即开始进行；b需要推迟到某些条件（例如资金、人力、设备等）落实之后才能开始进行；c 需要对开发目标进行某些修改之后才能开始进行；d不能进行或不必进行（例如因技术不成熟、经济上不合算等）。模块开发卷宗（GB856788）1标题软件系统名称和标识符模块名称和标识符（如果本卷宗包含多于一个的模块，则用这组模块的功能标识代替模块名）程序编制员签名卷宗的修改文本序号修改完成日期卷宗序号（说明本卷宗在整个卷宗中的序号）编排日期（说明整个卷宗最近的一次编排日期）2模块开发情况表3功能说明扼要说明本模块（或本组模块）的功能，主要是输入、要求的处理、输出。可以从系统设计说明书中摘录。同时列出在软件需求说明书中对这些功能的说明的章、条、款。4设计说明说明本模块（或本组模块）的设计考虑，包括：a在系统设计说明书中有关对本模块（或本组模块）设计考虑的叙述，包括本模块在软件系统中所处的层次，它同其他模块的接口；b在程序设计说明书中有关对本模块（或本组模块）的设计考虑，包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等；c在编制目前已通过全部测试的源代码时实际使用的设计考虑。5原代码清单要给出所产生的本模块（或本组模块）的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源代码清单。6测试说明说明直接要经过本模块（或本组模块）的每一项测试，包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。7复审的结论把实际测试的结果，同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论。软件需求说明书的编写提示（GB856T88）1引言1.1编写目的说明编写这份软件需求说明书的目的，指出预期的读者。1.2背景说明：a待开发的软件系统的名称；b本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络；c该软件系统同其他系统或其他机构的基本的相互来往关系。1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4参考资料列出用得着的参考资料，如：a本项目的经核准的计划任务书或合同、上级机关的批文；b属于本项目的其他已发表的文件；c本文件中各处引用的文件、资料、包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。2任务概述2.1目标叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。解释被开发软件与其他有关软件之间的关系。如果本软件产品是一项独立的软件，而且全部内容自含，则说明这一点。如果所定义的产品是一个更大的系统的一个组成部分，则应说明本产品与该系统中其他各组成部分之间的关系，为此可使用一张方框图来说明该系统的组成和本产品同其他各部分的联系和接口。|2.2用户的特点列出本软件的最终用户的特点，充分说明操作人员、维护人员的教育水平和技术专长，以及本软件的预期使甩频度。这些是软件设计工作的重要约束2.3假定和约束列出进行本软件开发工作的假定和约束，例如经费限制、开发期限等。3需求规定3.1对功能的规定用列表的方式（例如IPO表即输入、处理、输出表的形式），逐项定量和定性地叙述对软件所提出的功能要求，说明输入什么量、经怎样的处理、得到什么输出，说明软件应支持的终端数和应支持的并行操作的用户数。3.2对性能的规定3.2.1精度说明对该软件的输入、输出数据精度的要求，可能包括传输过程中的精度。3.2.2时间特性要求说明对于该软件的时间特性要求，如对：a响应时间；b更新处理时间；c数据的转换和传送时间；d解题时间；等的要求。3.2.3灵活性说明对该软件的灵活性的要求，即当需求发生某些变化时，该软件对这些变化的适应能力，如：a操作方式上的变化；b运行环境的变化；c同其他软件的接口的变化；d精度和有效时限的变化；e计划的变化或改进。对于为了提供这些灵活性而进行的专门设计的部分应该加以标明。3.3输人输出要求解释各输入输出数据类型，并逐项说明其媒体、格式、数值范围、精度等。对软件的数据输出及必须标明的控制输出量进行解释并举例，包括对硬拷贝报告（正常结果输出、状态输出及异常输出）以及图形或显示报告的描述。3.4数据管理能力要求说明需要管理的文卷和记录的个数、表和文卷的大小规模，要按可预见的增长对数据及其分量的存储要求作出估算。3.5故障处理要求列出可能的软件、硬件故障以及对各项性能而言所产生的后果和对故障处理的要求。3.6其他专门要求如用户单位对安全保密的要求，对使用方便的要求，对可维护性、可补充性、易读性、可靠性、运行环境可转换性的特殊要求等。4运行环境规定4.1设备列出运行该软件所需要的硬设备。说明其中的新型设备及其专门功能，包括：a处理器型号及内存容量；b外存容量、联机或脱机、媒体及其存储格式，设备的型号及数量；c输入及输出设备的型号和数量，联机或脱机；d数据通信设备的型号和数量；e功能键及其他专用硬件4.2支持软件列出支持软件,包括要用到的操作系统、编译（或汇编）程序、测试支持软件等。4.3接口说明该软件同其他软件之间的接口、数据通信协议等。4.4控制说明控制该软件的运行的方法和控制信号，并说明这些控制信号的来源。数据库设计说明书（GB856788）1引言1.1编写目的说明编写这份数据库设计说明书的目的，指出预期的读者。1.2背景说明：a说明待开发的数据库的名称和使用此数据库的软件系统的名称；b列出该软件系统开发项目的任务提出者、用户以及将安装该软件和这个数据库的计算站（中心）。1.3定义列出本文件中用到的专门术语的定义、外文首字母组词的原词组。1.4参考资料列出有关的参考资料：a本项目的经核准的计划任务书或合同、上级机关批文；b属于本项目的其他已发表的文件；c本文件中各处引用到的文件资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。2外部设计2.1标识符和状态联系用途，详细说明用于唯一地标识该数据库的代码、名称或标识符，附加的描述性信息亦要给出。如果该数据库属于尚在实验中、尚在测试中或是暂时使用的，则要说明这一特点及其有效时间范围。2.2使用它的程序列出将要使用或访问此数据库的所有应用程序，对于这些应用程序的每一个，给出它的名称和版本号。2.3约定陈述一个程序员或一个系统分析员为了能使用此数据库而需要了解的建立标号、标识的约定，例如用于标识数据库的不同版本的约定和用于标识库内各个文卷、记录、数据项的命名约定等。2.4专门指导向准备从事此数据库的生成、从事此数据库的测试、维护人员提供专门的指导，例如将被送入数据库的数据的格式和标准、送入数据库的操作规程和步骤，用于产生、修改、更新或使用这些数据文卷的操作指导。如果这些指导的内容篇幅很长，列出可参阅的文件资料的名称和章条。2.5支持软件简单介绍同此数据库直接有关的支持软件，如数据库管理系统、存储定位程序和用于装入、生成、修改、更新数据库的程序等。说明这些软件的名称、版本号和主要功能特性，如所用数据模型的类型、允许 的数据容量等。列出这些支持软件的技术文件的标题、编号及来源。3结构设计3.1概念结构设计说明本数据库将反映的现实世界中的实体、属性和它们之间的关系等的原始数据形式，包括各数据项、记录、系、文卷的标识符、定义、类型、度量单位和值域，建立本数据库的每一幅用户视图。3.2逻辑结构设计说明把上述原始数据进行分解、合并后重新组织起来的数据库全局逻辑结构，包括所确定的关键字和属性、重新确定的记录结构和文卷结构、所建立的各个文卷之间的相互关系，形成本数据库的数据库管理员视图。3.3物理结构设计建立系统程序员视图，包括：a数据在内存中的安排，包括对索引区、缓冲区的设计；b所使用的外存设备及外存空间的组织，包括索引区、数据块的组织与划分；c访问数据的方式方法。4运用设计4.1数据字典设计对数据库设计中涉及到的各种项目，如数据项、记录、系、文卷、模式、子模式等一般要建立起数据字典，以说明它们的标识符、同义名及有关信息。在本节中要说明对此数据字典设计的基本考虑。4.2安全保密设计说明在数据库的设计中，将如何通过区分不同的访问者、不同的访问类型和不同的数据对象，进行分别对待而获得的数据库安全保密的设计考虑。数据要求说明书（GB856T88）1引言1.1编写目的说明编写这份数据要求说明书的目的，指出预期的读者。1.2背景说明：a.待开发软件系统的名称；b.列出本项目的任务提出者、开发者、用户以及将运行该项软件的计算站（中心）或计算机网络系统。1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4参考资料列出有关的参考资料，如：a.本项目的经核准的计划任务书或合同，上级机关的批文；b.属于本项目的其他已发表文件；c.本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位。说明能够得到这些文件资料的来源。2数据的逻辑描述对数据进行逻辑描述时可把数据分为动态数据和静态数据。所谓静态数据，指在运行过程中主要作为参考的数据，它们在很长的一段时间内不会变化，一般不随运行而改变。所谓动态数据，包括所有在运行中要发生变化的数据以及在运行中要输入、输出的数据。进行描述时应把各数据元素逻辑地分成若干组，列如函数、源数据或对于其应用更为恰当的逻辑分组。给出每一数据元的名称（包括缩写和代码）、定义（或物理意义）度量单位、值域、格式和类型等有关信息。2.1静态数据列出所有作为控制或参考用的静态数据元素。2.2动态输人数据列出动态输入数据元素（包括在常规运行中或联机操作中要改变的数据）。2.3动态输出数据列出动态输出数据元素（包括在常规运行中或联机操作中要改变的数据）。2.4内部生成数据列出向用户或开发单位中的维护调试人员提供的内部生成数据。2.5数据约定说明对数据要求的制约。逐条列出对进一步扩充或使用方面的考虑而提出的对数据要求的限制（容量、文卷、记录和数据元的个数的最大值）。对于在设计和开发中确定是临界性的限制更要明确指出。3数据的采集3.1要求和范围按数据元的逻辑分组来说明数据采集的要求和范围，指明数据的采集方法，说明数据采集工作的承担者是用户还是开发者。具体的内容包括：a.输入数据的来源，例如是单个操作员、数据输入站，专业的数据输入公司或它们的一个分组；b.数据输入（指把数据输入处理系统内部）所用的媒体和硬设备。如果只有指定的输入点的输入才是合法的，则必须对此加以说明；c.接受者说明输出数据的接受者；d.输出数据的形式和设备列出输出数据的形式和硬设备。无论接受者将接收到的数据是打印输出，还是CRT上的一组字符、一帧图形，或一声警铃，或向开关线圈提供的一个电脉冲，或常用介质如磁盘、磁带、穿孔卡片等，均应具体说明；e.数据值的范围给出每一个数据元的合法值的范围；f.量纲给出数字的度量单位、增量的步长、零点的定标等。在数据是非数字量的情况下，要给出每一种合法值的形式和含意；g.更新和处理的频度给出预定的对输入数据的更新和处理的频度。如果数据的输入是随机的，应给出更新处理的频度的平均值，或变化情况的某种其他度量。3.2输人的承担者说明预定的对数据输入工作的承担者。如果输入数据同某一接口软件有关，还应说明该接口软件的来源。3.3预处理对数据的采集和预处理过程提出专门的规定，包括适合应用的数据格式、预定的数据通信媒体和对输入的时间要求等。对于需经模拟转换或数字转换处理的数据量，要给出转换方法和转换因子等有关信息，以便软件系统使用这些数据。3.4影响说明这些数据要求对于设备、软件、用户、开发单位所可能产生的影响，例如要求用户单位增设某个机构等。文件给制实施规定的实例（GB8567-88）尽管在文件编制中存在着很多灵活性，然而，文件的编制确实是非常必要的，其意义如前所述。为了控制这种灵活性，保证文件编制能达到应该达到的目的，对于具体的软件开发任务，应编制的文件的种类、详细程度应取决于承担开发单位的管理能力、任务的规模、复杂性和成败风险等因素。一个软件开发单位应该根据本单位经营承包的应用软件的专业特点和本单位的管理能力，制定一个文件编制实施规定，说明在什么情况下应该编制哪些文件。由于国内目前在这方面还缺乏成熟的经验，这里提供参考国外经验制定的两个例子，用以向国内软件开发单位说明如何建立这种实施规定，使项目负责人能确定本项目开发过程中应编制的文件的种类。当然，例子毕竟只是例子，这两个例子各自都不免有其片面性，它们两者之间也不免有不一致之处，之所以列出来无非是供国内软件开发单位参考。例1：此例规定用求和法来确定应编制的文件。该方法的要点是提出十二个考虑因素来衡量一个应用软，件，每个因素可能取值的范围是互至5。任务负责人可用这十二个因素对所要开发的程序进行衡量，确定每个因素的具体值。把这十二个因素的值相加，得到一个总和。然后由这个总和的值来确定应该编制的文件的种类。使用这个方法的具体过程如下：a.按表OI中的十二个因素衡量所要开发的程序，得到每个因素的值；b.把衡量所得的各个因素的值相加，得总和之值；c.根据总和之值，从表OZ查出应编制的文件的种类。表1文件编制的十二项衡量因素序号因素因素取值准则123451创造性要求没有在不同的设备上重编程序很少具有严格的要求有限具有新的接口相当多应用现有的技巧重大的应用先进的技巧2通用程度很强的限制单一目标有限制功能的范围是参量化的有限的灵活性允许格式上有某些变化多用途，灵活的格式有一个主题领域很灵活能在不同的设备上处理范围广泛的主题3工作范围局部单位分指挥部单个指挥部多个指挥部国防部，世界范围4目标范围的变化没有极少偶尔有经常不断5设备复杂性单机，常规处理单机，常规处理，扩充的外设系统多机，标准外设系统多机，复杂的外设系统主机控制系统，多机，自动I/O和显示6人员12人35人510人1018人18人以上7开发投资6人月以下6人月至3人年3人年至10人年10人年至30人年30人年以上8重要程度数据处理常规过程控制人身安全单位成败国家安全9对程序改变的完成时间要求2周以上12周37天13天24小时以内10对数据输入的响应时间要求2周以上12周17天124小时60分钟内11程序语言高级语言高级语言带一些汇编高级语言带相当多的汇编汇编语言机器语言12并行的软件开发没有有限中等程度很多完全的并行开发表1文件编制的十二项衡量因素因素总和可行性研究报告项目开发计划软件需求说明书数据要求说明书概要设计说明书详细设计说明书数据库设计说明书用户手册（使用说明）操作手册模块开发卷宗测试设计测试分析报告项目开发总结报告开发制度月报1218*1424243838504860*在因素总和较低的情况下,项目开发总结报告的内容应包括：程序的主要功能、基本流程、测试结果和使用说明。*测试分析报告应该写，但不必很正规。*数据要求说明和数据库设计说明是否需要编写应根据所开发软件的实际需要来决定。例2：为了避免在软件开发中文件编制的不足或过分，一个简便的办法是把对软件文件的编制要求同软件的规模大小联系起来，这就是本例的出发点。软件的规模不妨分为四级：1.小规模软件源程序行数小于5000的软件；2.中规模软件源程序行数为1000050000的软件；3.大规模软件源程序行数为100000500000的软件；4.特大规模软件源程序行数大于500000的软件。对上述的四级软件的文件编制要求分别列于表3。至于源程序行数为500010000，50000100000的软件，其文件编制要求介于两级之间，可根据一个软件产品的具体情况，由项目负责人参照表3的规定，确定需要编制的文件种类。对于源程序行数大于500000的特大规模软件，可进一步把本指南规定的十四种文件按实际需要扩展成更多种类。详细设计说明书（GB856788）详细设计说明书（GB856788）1引言1.1编写目的说明编写这份详细设计说明书的目的，指出预期的读者。1.2背景说明：a待开发软件系统的名称；b本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。1.3定义列出本文件中用到专门术语的定义和外文首字母组词的原词组。1.4参考资料列出有关的参考资料，如：a本项目的经核准的计划任务书或合同、上级机关的批文；b属于本项目的其他已发表的文件；c本文件中各处引用到的文件资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。2程序系统的结构用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间 的层次结构关系。3程序1（标识符）设计说明从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层 模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。3.1程序描述给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如 是常驻内存还是非常驻？是否子程序？是可重人的还是不可重人的？有无覆盖要求？是顺序处理还是并发处理等）。3.2功能说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。3.3性能说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。3.4输人项给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等等。3.5输出项给出对每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效范围，输出的形式、数量和频度，输出媒体、对输出图形及符号的说明、安全保密条件等等。3.6算法详细说明本程序所选用的算法，具体的计算公式和计算步骤。3.7流程逻辑用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。3.8接口用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。3.9存储分配根据需要，说明本程序的存储分配。3.10注释设计说明准备在本程序中安排的注释，如：a加在模块首部的注释；b加在各分枝点处的注释；c对各变量的功能、范围、缺省条件等所加的注释；d对使用的逻辑所加的注释等等。3.11限制条件说明本程序运行中所受到的限制条件。3.12测试计划说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。3.13尚未解决的问题说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。4程序2（标识符）设计说明项目开发计划（GB856T88）1、引