(完整版)软件需求文档说明_标准版
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
文件版次:
1引言 (4)
1.1 文档编制目的 (4)
1.2 背景 (4)
1.3 词汇表 (4)
1.4 参考资料 (4)
2软件概述 (4)
2.1软件范围定义 (4)
2.2 系统特性概述 (4)
2.3 系统运行环境 (5)
2.3.1 设备及分布 (5)
2.3.2 支撑软件 (5)
2.4 假定和依赖 (5)
3外部接口需求 (5)
3.1 用户界面 (5)
3.2软件接口 (6)
4需求规格 (6)
4.1 系统特性1(编号/名称) (6)
4.1.1 系统特性说明 (6)
4.1.2 功能需求 (6)
4.2 系统特性2(编号/名称) (7)
5其他非功能需求 (7)
5.1 一般性性能需求 (7)
5.2 一般性安全性需求 (7)
5.3 用户文档需求 (7)
6其他需求 (7)
7附件 (7)
编写指南:
本模板力图给出软件需求分析阶段可能包括的基本信息。
如果某个章节在项目或当前阶段中无法描述,则可保留其标题,注明“不适用”;如果需要对本模板的个别章节详细描述,也可将其形成单独的文档,成为本文档附件。
若文档中的某个章节已经在其他项目文档中加以描述,可保留标题,注明“参见(文档编号)(文档名称)(条款)”。
形成正式文档后须删除斜体字内容。
1引言
1.1 文档编制目的
说明编写这份报告的目的,指出预期的读者。
1.2 背景
叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料;明确需求分析过程涉及到的相关方。
1.3 词汇表
列出本软件需求规格说明书中专门术语的定义、英文缩写词的原词组和意义、项目组内达成一致意见的专用词汇,同时要求继承全部的先前过程中定义过的词汇。
备注中注明该词汇的来源,或有其他更详细的解释的文档位置;以及对该词汇的其他叫法。
1.4 参考资料
列出编写本报告时参考的文件、资料、技术标准以及他们的作者、标题、编号、出版日期和出版单位。
列出编写本报告时查阅的Internet上杂志、专业著作、技术标准以及其网址。
2软件概述
2.1 软件范围定义
对待开发的软件系统及其目的进行简短描述,包括利益和目标。
把软件与企业目标或业务策略相联系。
解释待开发软件与其他有关软件之间的关系:如果本软件产品是一项独立的软件,而且全部内容自含,则说明这一点;如果所定义的产品是一个更大的系统的一个组成部分,则应说明本产品与该系统中的其他各组成部分之间的关系,为此可使用方框图或表格来说明该系统的组成和本产品同其他各部分的联系和接口。
2.2 系统特性概述
概括描述待开发的软件能够为用户提供哪些服务,详细内容将在4中给出。
可以使用列表的方式给出,对软件的系统特性进行适当的组织,使每个读者都易于理解,同时须确定系统特性的优先级(“高”、“中”、“低”)。
也可以采用图形描述各系统特性之间的分组情况以及它们之间的联系,例如概念图、数据流图的顶层图或类图。
2.3 系统运行环境
2.3.1 设备及分布
1)主机类型
2)网络类型
3)存贮器容量
4)其他特殊设备
5)设备分布图
2.3.2 支撑软件
1)操作系统
2)数据库管理系统
3)其他支撑软件
2.4 假定和依赖
列举出在对本文档中确定的需求进行描述的时候的假设条件。
包括预计使用的商业组件、行业法规、开发或运行环境的问题。
描述软件系统对外部因素存在的依赖。
例如,若打算把其他项目开发的组件集成到系统中,那么就要依赖另一个项目按时提供正确的组件。
3外部接口需求
简要说明该软件同其他软件之间的公共接口、数据通信协议等,如果外部接口仅与某子功能有关,该接口说明需单独陈述。
可以使用关联图描述高层抽象的接口信息,也可根据需要将对接口数据和控制组件的详细描述写入数据字典中。
3.1 用户界面
描述需要的用户界面的逻辑特征。
这些特征包括但不限于:
1)将要采用的图形用户界面(GUI)标准或产品系列的风格;
2)屏幕布局或解决方案的限制;
3)将出现在每个屏幕的标准按钮、功能或导航链接(例如一个帮助按钮);
4)快捷键;
5)错误信息显示标准。
对于用户界面的细节,例如特定的对话框的布局,在这里不必详细描述,以免由于过分的细节规定影响项目的开发进度以及开发人员的创造能力。
3.2 软件接口
描述软件系统与其他外部组件(须注明名称和版本)的连接,包括数据库、操作系统、工具软件、库和集成的商业组件。
明确在软件组件之间交换数据的目的,描述所需要的服务以及内部组件通信的性质。
确定将在组件间共享的数据。
4 需求规格
列出待开发软件系统中所有系统特性及每个特性中所包含的功能集。
如果系统特性的功能集和细化的子功能比较繁多,可以将每个系统特性分别编写“软件需求规格说明”,在本处列出文档编号和分册名称。
在本文档中,功能需求的描述是根据系统特性即软件所提供的服务来组织的。
根据项目的实际需要,也可以通过使用实例、运行模式、用户类、对象类或需求优先级的描述方法对这部分内容加以辅助说明。
在描述时尽量使用简短明了的语句定义系统特性和功能的名称。
例如:“拼写检查和拼写字典管理”。
为满足确定的软件需求的可跟踪性和可维护性,需唯一确定每个系统特性及相应的功能,尤其对于需求复杂度较高、项目规模较大的项目,唯一性标识尤为必要。
对需求的标识可以采用序列号(UR-2;SRS-31B)、层次编码(4.1.3.2)或自定义其他的方法。
在下面的系统特性和相应功能集的描述中贯彻并在项目组内达成一致。
4.1 系统特性1(编号/名称)
这部分要求对每个系统特性以及包含的功能集分别进行描述。
4.1.1 系统特性说明
对该系统特性面向的最终用户、能够提供的具体服务以及使用时机和必要的依赖关系进行简明、清晰的描述。
4.1.2 功能需求
详细列出该系统特性包含的功能集。
这些是须提交给用户的软件功能,使用户可以使用所提供的特性执行特定的服务。
描述各功能需求如何响应可预知的出错条件或者非法输入或动作。
对每个功能需唯一标识。
4.2 系统特性2(编号/名称)
……
5 其他非功能需求
5.1 一般性性能需求
详细描述不同应用领域对软件性能的需求,解释它们的原理以帮助设计人员做出合理的设计选择。
确定相互合作的用户数或者所支持的操作、响应时间以及与实时系统的时间关系。
定义容量需求,例如存储器和磁盘空间的需求或者存储在数据库中表的最大行数等。
5.2 一般性安全性需求
详细描述与系统安全性、完整性或与登录到该系统的使用人员的隐私相关的需求,这些问题会影响到软件系统的使用以及创建或使用的数据的保护。
定义用户身份确认或授权需求。
明确产品必须满足达到安全性或保密性策略。
如有必要,须描述与产品使用过程中可能发生的损失、破坏或危害相关的需求。
定义必须采取的安全保护或动作,预防潜在的危险动作。
明确软件系统必须遵循的安全标准和规则。
例如如果油箱的压力超过了规定的最大压力的95%,那么必须在1秒钟之内停止操作。
5.3 用户文档需求
列举出将与软件系统一同提交的用户文档,例如用户手册和在线帮助和教程。
明确用户文档的提交格式或编制标准。
6 其他需求
定义在本文档的其他部分未出现的但需要提起注意的需求:
1)特定的业务规则,例如某些最终用户只有在特定的环境下才可以执行何种操作;
2)国际化需求或法律法规的需求;
3)需要增加有关操作、管理和维护的功能需求来完善软件系统的安装、配置、启动和关闭、修复和容错以及登录和监控等方面的操作。
7 附件
需求调查过程中会产生各种记录如业务系统单据等。
记录或报告的存档编号和名称填写在下表中。
其
中类别是记录的分类,一般有业务系统说明书、业务系统数据说明书、业务系统调查表、原始数据单据、业务系统参考资料。
《需求调查表》
《需求跟踪矩阵》
《项目风险管理表》。