软件工程文档标准

A.1　软件开发文件模板（规范性附录）A.1.1　软件需求说明书软件需求说明书项目名称：委托单位：承担单位：编写：年月日校对：年月日审核:年月日批准:年月日《软件需求说明书》的编制是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解，使之成为整个开发工作的基础。《软件需求说明书》编制指导如下。1引言1.1编写目的说明编写这份《软件需求说明书》的目的，指出预期的读者。1.2背景说明待开发的软件系统的名称、版本号说明、本项目的任务提出者、开发者、用户以及该软件系统同其他系统的关系。1.3修订审批记录说明编写这份《软件需求说明书》的修订过程、审批过程。参见文档修订记录表及文档审批记录表。表1文档修订记录表修订记录章节修订日期版本修订描述修订者审核者表2文档审批记录表审批记录审批方式审批日期版本文档所有者提交者审批者1.4术语和缩写词列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.5参考资料列出本文件中用到的参考资料（参考格式：作者、名称、出版单位、发表日期等）。2任务概述2.1目标叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。2.2业务需求叙述本软件最终用户的原始业务需求，包括：业务现状、预期功能需求、预期性能需求以及其他专门需求，为需求分析提供支持。2.3用户特点列出本软件的最终用户的特点，充分说明操作人员、维护人员的教育水平和技术专长，以及本软件的预期使甩频度。这些是软件设计工作的重要约束。2.4假设和约束列出进行本软件开发工作的假定和约束，例如经费限制、开发期限等。3总体需求23.1组织结构绘出待开发软件系统最终用户的组织结构图，并对各组织的作用以及相互关系加以说明。3.2业务流程说明待开发软件系统的业务流程。此流程可用图表即流程图的形式表示，并加以叙述。3.3数据流程说明待开发软件系统的数据流程。此流程可用图表即流程图的形式表示，并加以叙述。4需求规定4.1功能需求从以下四个部分，详细叙述每一类功能或每一个功能对软件所提出的功能要求，说明输入什么量、经过怎样处理、得到什么输出：(1)引言该功能要达到的目标、所采用的方法和技术。还应清楚说明该功能意图的由来和背景。(2)输入该功能的所有输入以及输入操作时控制细节的需求。(3)加工定义输入数据、中间参数，以及获得预期输出结果的全部操作。它包括如下的说明：输入数据的有效性检查；操作的顺序；响应，例如，溢出、通信故障、错误处理等；用于把系统输入变换成相应输出的任何方法（方程式、数学算法、逻辑操作等）；输出数据的有效性检查。(4)输出该功能所有输出以及非法值的处理、出错信息。4.2性能需求说明对该软件的输入、输出数据精度的要求、对时间特性要求以及对对灵活性的要求。4.3其他专门需求说明对安全保密的要求、对使用方便的要求以及对可靠性、维护性、可扩充性的特殊要求等。5运行环境规定5.1设备列出运行该软件所需要的硬设备。5.2支持软件环境列出支持软件,包括要用到的操作系统、编译（或汇编）程序、测试支持软件等。5.3接口说明该软件同其他软件之间的接口、数据通信协议等。3A.1.2　系统设计说明书系统设计说明书项目名称：委托单位：承担单位：编写：年月日校对：年月日审核:年月日批准:年月日4Q/SYXJXXXX—2007《系统设计说明书》的编制，是为了说明对程序系统的设计考虑。《系统设计说明书》编制指导如下。1引言1.1编写说明说明编写这份《系统设计说明书》的目的，指出预期的读者。1.2背景说明待开发的软件系统的名称、版本号说明、本项目的任务提出者、开发者、用户以及该软件系统同其他系统的关系。1.3修订审批记录说明编写这份《系统设计说明书》的修订过程、审批过程。参见文档修订记录表及文档审批记录表。表1文档修订记录表修订记录章节修订日期版本修订描述修订者审核者表2文档审批记录表审批记录审批方式审批日期版本文档所有者提交者审批者1.4需求概述简略说明待开发的软件系统的基本需求。详细的说明可参见《软件需求说明书》。1.5术语和缩写词列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.6参考资料列出本文件中用到的参考资料（参考格式：作者、名称、出版单位、发表日期等）。2总体设计2.1软件实现技术及特点5Q/SYXJXXXX—2007简要列出开发本软件系统的所使用的技术及特点。2.2基本设计概念和处理流程说明本系统的基本设计概念和处理流程，尽量使用图表的形式。2.3结构设计用图表的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系。2.4运行环境设计说明本程序运行时所必需的环境条件。2.5接口设计说明本系统同外界接口的安排（包括软件与硬件之间的接口）、本系统与各支持软件之间的接口关系。以及关于用户接口、内部接口的相关说明。2.6出错处理设计说明系统出错时输出信息的形式、含意及处理方法；故障出现后可能采取的变通措施以及为了系统维护的方便而在程序内部设计中所做出的安排。2.7安全保密设计关于系统安全保密的相关安排和处理。2.8标识符设计说明准备在本程序中安排的标识符。3模块设计从功能描述、处理流程、界面设计、出错处理设计等方面，逐个地给出各个层次中的每个模块的设计考虑。3.1模块1a.功能描述以条目的方式详细说明该模块的功能。b.处理流程以图示（流程图，时序图，活动图）方式描述功能模块的实现原理。c.界面设计绘制该功能的实现界面及界面之间的关系。d.出错处理设计6Q/SYXJXXXX—2007描述功能模块的出错情况和容错机制。3.2模块2用类似本文3.1节的方式给出第2项及其后各项模块设计描述。．．．．．．。3.n模块n．．．．．．。A.1.3　数据库设计说明书数据库设计说明书项目名称：委托单位：7Q/SYXJXXXX—2007承担单位：编写：年月日校对：年月日审核:年月日批准:年月日《数据库设计说明书》的编制，是对于设计中的数据库的所有标识、逻辑结构和物理结构做出具体的设计规定。《数据库设计说明书》编制指导如下。1引言1.1编写说明说明编写这份《数据库设计说明书》的目的，指出预期的读者。1.2背景说明待开发数据库的名称、版本号说明、使用范围并列出本项目的任务提出者和开发者。1.3修订审批记录说明编写这份《数据库设计说明书》的修订过程、审批过程。参见文档修订记录表及文档审批记录表。表1文档修订记录表8Q/SYXJXXXX—2007修订记录章节修订日期版本修订描述修订者审核者表2文档审批记录表审批记录审批方式审批日期版本文档所有者提交者审批者1.4术语和缩写词列出本文件中用到的专门术语的定义、外文首字母组词的原词组。1.5参考资料列出本文件中用到的参考资料（参考格式：作者、名称、出版单位、发表日期等）。2外部设计2.1标识符和状态列出用于标识该数据库的编码、名称、标识符或标号，并给出附加的描述性信息。如果该数据库是在实验中的或者暂时性的，则要说明这一特点和有效期。2.2使用该数据库的程序列出将要使用或访问此数据库的所有应用程序，给出其名称和版本号。2.3约定叙述使用该数据库所必须了解的建立标号、标识的有关约定。例如，用于标识库内各个文卷、记录、数据项的命名约定等。2.5支持软件叙述与此数据库有关的支持软件，如数据库管理系统、存储定位程序等。概要说明这些支持软件的名称、功能及为使用这些支持软件所需的操作命令。列出这些支持软件的有关资料。2.6专门说明向准备从事此数据库的生成、测试、维护人员所提供的专门说明。9Q/SYXJXXXX—20073结构设计3.1概念结构设计详细说明本数据库的用户视图，即反映现实世界中的实体、属性和它们之间关系的原始数据形式。包括各种数据项及数据项的数据类型、宽度、小数位、计量单位、值域和描述以及各种记录、数据表标识符等；描述E_R模型的设计考虑，并参照新疆油田公司数据标准绘制E_R图。3.2逻辑结构设计详细说明本数据库的数据库管理员视图，即把上述原始数据进行分解、合并后重新组织起来的数据库全局逻辑结构，包括所确定的关键字和属性、重新确定的记录结构和数据表结构、所建立的各个数据表之间的相互关系，并参照新疆油田公司数据标准编写《数据库逻辑结构》。3.3物理结构设计详细说明本数据库的系统程序员视图，即数据在内存中的安排，包括对索引区、缓冲区的设计；所使用的外存设备及外存空间的组织，包括索引区、数据块的组织与划分以及访问数据的方式方法。4运用设计4.1数据字典设计详细说明对数据字典设计的基本考虑。包括数据库设计中涉及到的各种项目，如数据项、记录、数据表、模式、子模式等，描述它们的标识符、同义名及有关信息。4.2完整性设计说明为保持数据库中数据的完整性所作的设计考虑，如数据库的后援频率、数据共享、数据冗余等。4.2安全保密设计说明在数据库的设计中，将如何通过区分不同的访问者、不同的访问类型和不同的数据对象等而获得数据库安全保密的设计考虑。以及将要采用的保证数据安全保密的措施和机制，如数据库安全破坏标识、资源保护方式、存取控制方式等。5.其它设计说明其它设计考虑。A.1.4　测试总结报告10Q/SYXJXXXX—2007测试总结报告项目名称：委托单位：承担单位：编写：年月日校对：年月日审核:年月日11Q/SYXJXXXX—2007批准:年月日《测试总结报告》，是为了把集成测试、系统测试和上线测试的结果、发现及分析写成文件加以记载。《测试总结报告》编制指导如下。1．引言1.1编写目的说明编写这份《测试总结报告》的目的，指出预期的读者。1.2背景说明待测试软件系统的名称、版本号说明、列出本项目的任务提出者、开发者和用户。1.3修订审批记录说明编写这份《测试总结报告》的修订过程、审批过程。参见文档修订记录表及文档审批记录表。表1文档修订记录表修订记录章节修订日期版本修订描述修订者审核者表2文档审批记录表审批记录审批方式审批日期版本文档所有者提交者审批者1.4术语和缩写词列出本文中用到的专门术语的定义、外文首字母组词的原词组。1.5参考资料列出本文中用到的参考资料（参考格式：作者、名称、出版单位、发表日期等）。2.测试概要12Q/SYXJXXXX—20072.1测试结果及发现用表格形式列出每一项测试的名称、测试内容、预期结果和实际结果，陈述其中的各项发现。参见测试概要表。表3测试概要表序号测试项名称测试内容预期结果实际结果测试发现2.2测试缺陷综述说明测试过程中所发现的缺陷数目、缺陷的表现形式及发现的环境。3.对软件功能的结论说明软件系统中每一项功能的设计能力、经过测试已确认的能力、缺陷和限制，并给出建议。3.1功能1（标识符）3.1.1能力简述该项功能，说明为满足此项功能而设计的软件能力以及经过一项或多项测试已证实的能力。3.1.2缺陷与限制说明测试数据值的范围（包括动态数据和静态数据），列出就这项功能而言，测试期间在该软件中查出的缺陷、局限性。3.1.3建议对测试出的每项缺陷或限制提出修改意见，说明各项修改的紧急程度以及修改时可采用的方法和工作量。3.2功能2（标识符）用类似本文3.1节的方式给出第2项及其后各项功能的测试结论。......。3.n功能n（标识符）......。4.对软件系统的评价4.1能力说明经测试证实了的本软件系统的能力。4.2缺陷和限制说明经测试证实的软件缺陷和限制。说明每项缺陷和限制对软件性能的影响，并说明全部测得的性能缺陷的累积影响和总影响。4.3建议对软件系统的修改意见与建议。13Q/SYXJXXXX—20074.4评价说明该软件系统是否已达到预定目标，能否交付使用。5测试资源消耗统计测试过程消耗的人力、物力、机时等。14Q/SYXJXXXX—2007A.1.5　项目开发总结报告项目开发总结报告项目名称：委托单位：承担单位：编写：年月日校对:年月日15Q/SYXJXXXX—2007审核：年月日批准:年月日编制《项目开发总结报告》，是为了总结本项目开发工作的经验，说明实际取得的开发结果以及对整个开