软件工程文档标准.pdf

《软件工程文档标准.pdf》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、A.1软件开发文件模板（规范性附录）A.1.1软件需求说明书软件需求说明书项目名称：委托单位：承担单位：编写：年月日校对：年月日审核:年月日批准:年月日《软件需求说明书》的编制是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解，使之成为整个开发工作的基础。《软件需求说明书》编制指导如下。1引言1.1编写目的说明编写这份《软件需求说明书》的目的，指出预期的读者。1.2背景说明待开发的软件系统的名称、版本号说明、本项目的任务提出者、开发者、用户以及该软件系统同其他系统的关系。1.3修订审批记录说明编写这份《软件需求说明书》的修订过程、审批过程。参

2、见文档修订记录表及文档审批记录表。表1文档修订记录表修订记录章节修订日期版本修订描述修订者审核者表2文档审批记录表审批记录审批方式审批日期版本文档所有者提交者审批者1.4术语和缩写词列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.5参考资料列出本文件中用到的参考资料（参考格式：作者、名称、出版单位、发表日期等）。2任务概述2.1目标叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。2.2业务需求叙述本软件最终用户的原始业务需求，包括：业务现状、预期功能需求、预期性能需求以及其他专门需求，为需求分析提供

3、支持。2.3用户特点列出本软件的最终用户的特点，充分说明操作人员、维护人员的教育水平和技术专长，以及本软件的预期使甩频度。这些是软件设计工作的重要约束。2.4假设和约束列出进行本软件开发工作的假定和约束，例如经费限制、开发期限等。3总体需求23.1组织结构绘出待开发软件系统最终用户的组织结构图，并对各组织的作用以及相互关系加以说明。3.2业务流程说明待开发软件系统的业务流程。此流程可用图表即流程图的形式表示，并加以叙述。3.3数据流程说明待开发软件系统的数据流程。此流程可用图表即流程图的形式表示，并加以叙述。4需求规定4.1功能需求从以下四个部分，详细叙

4、述每一类功能或每一个功能对软件所提出的功能要求，说明输入什么量、经过怎样处理、得到什么输出：(1)引言该功能要达到的目标、所采用的方法和技术。还应清楚说明该功能意图的由来和背景。(2)输入该功能的所有输入以及输入操作时控制细节的需求。(3)加工定义输入数据、中间参数，以及获得预期输出结果的全部操作。它包括如下的说明：输入数据的有效性检查；操作的顺序；响应，例如，溢出、通信故障、错误处理等；用于把系统输入变换成相应输出的任何方法（方程式、数学算法、逻辑操作等）；输出数据的有效性检查。(4)输出该功能所有输出以及非法值的处理、出错信息。4.2性能需求说明对该

5、软件的输入、输出数据精度的要求、对时间特性要求以及对对灵活性的要求。4.3其他专门需求说明对安全保密的要求、对使用方便的要求以及对可靠性、维护性、可扩充性的特殊要求等。5运行环境规定5.1设备列出运行该软件所需要的硬设备。5.2支持软件环境列出支持软件,包括要用到的操作系统、编译（或汇编）程序、测试支持软件等。5.3接口说明该软件同其他软件之间的接口、数据通信协议等。3A.1.2系统设计说明书系统设计说明书项目名称：委托单位：承担单位：编写：年月日校对：年月日审核:年月日批准:年月日4Q/SYXJXXXX—2007《系统设计说明书》的编制，是为了说明对程

6、序系统的设计考虑。《系统设计说明书》编制指导如下。1引言1.1编写说明说明编写这份《系统设计说明书》的目的，指出预期的读者。1.2背景说明待开发的软件系统的名称、版本号说明、本项目的任务提出者、开发者、用户以及该软件系统同其他系统的关系。1.3修订审批记录说明编写这份《系统设计说明书》的修订过程、审批过程。参见文档修订记录表及文档审批记录表。表1文档修订记录表修订记录章节修订日期版本修订描述修订者审核者表2文档审批记录表审批记录审批方式审批日期版本文档所有者提交者审批者1.4需求概述简略说明待开发的软件系统的基本需求。详细的说明可参见《软件需求说明书》。

7、1.5术语和缩写词列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.6参考资料列出本文件中用到的参考资料（参考格式：作者、名称、出版单位、发表日期等）。2总体设计2.1软件实现技术及特点5Q/SYXJXXXX—2007简要列出开发本软件系统的所使用的技术及特点。2.2基本设计概念和处理流程说明本系统的基本设计概念和处理流程，尽量使用图表的形式。2.3结构设计用图表的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系。2.4运行环境设计说明本程序运行时所必

8、需的环境条件。2.5接口设计说明本系统同外界接口的安排（包括软件与硬件之间的接口