如何写规范需求分析说明书?
------解决方案--------------------------------------------------------
建议参照机械工业出版社译《软件需求》和RUP中风险承担者请求模板的形式。
------解决方案--------------------------------------------------------
软件需求规格说明书
(模板)
内容表
1 引言
1.1 目的
1.2 文档约定
1.3 预期的读者和阅读建议
1.4 产品的范围
1.5 参考文献
2 综合描述
2.1 产品的前景
2.2 产品的功能
2.3 用户类和特征
2.4 运行环境
2.5 设计和实现上的限制
2.6 假设和依赖
3 外部接口要求
3.1 用户界面
3.2 硬件接口
3.3 软件接口
3.4 通信接口
4 系统特征
4.1 说明和优先级
4.2 激励/响应序列
4.3 功能需求
5 其他非功能需求
5.1 性能需求
5.2 安全设施需求
5.3 安全性需求
5.4 软件质量属性
5.5 业务规则
5.6 用户文档
6 其他需求
附录A 词汇表
附录B 分析模型
附录C 待确定问题的列表
1 引言
提出对软件需求规格说明的纵览,帮助读者理解该文档是如何编写并且如何阅读和解释。
1.1 目的
对产品进行定义,在该文档中详尽说明这个产品的软件需求,包括修正或发行版本号。如果这个软件需求规格说明只与整个系统的一部分有关系,那么就只定义文档中说明的部分或子系统。
1.2 文档约定
描述编写文档时所采用的标准或排版约定,包括正文风格、提示区或重要符号。例如,说明高层需求的优先级是否可以被其所有细化的需求所继承,或者每个需求陈述是否都有其自身的优先级。
1.3 预期的读者和阅读建议
列举了软件需求规格说明所针对的不同读者。例如开发人员、项目经理、营销人员、用户、测试人员或文档编写人员。描述了文档中剩余部分的内容及其组织结构。提出了最适合于每一类型读者阅读文档的建议。
1.4 产品的范围
提供了对指定的软件及其项目的简短描述,包括利益和目标。把软件与企业目标或业务策略相联系。可以参考项目视图和范围文档而不是将其内容复制到这里 。
1.5 参考文献
列举了编写软件需求规格说明时所参考的资料或其他资源。可能包括用户界面风格指导、合同、标准、系统需求规格说明、使用实例文档,或相关产品的软件需求规格说明,在这里应该给出详细的信息,包括标题的名称、作者、版本号、日期、出版单位或资料来源,以方便读者查阅这些文献。
2 综合描述
概述了正在定义的产品以及它所运行的环境、使用产品的用户和已知的限制、假设和依赖。
2.1 产品的前景
描述了软件需求规格说明中所定义的产品的背景和起源。说明了该产品是否是产品系列中的下一成员,是否是成熟产品所改进的下一代产品、是否是现有应用程序的替代品,或者是否是一个新型的、自含型产品。如果软件需求规格说明定义了大系统的一个组成部分,那么就要说明这部分软件是怎样与整个系统相关联的,并且要定义出两者之间的接口。
2.2 产品的功能
概述了产品所具有的主要功能。其详细内容将在第4节中描述,所以在此只需要概括地总结。例如用列表的方法给出,很好的组织产品的功能,使每个读者都易于理解。用图形表示主要的需求分组以及他们之间的联系,例如数据流程图的顶层图或类图,都是有用的。
2.3 用户类和特征
确定可能使用该产品的不同用户类并描述他们相关的特征。有一些需求可能只与特定的用户类相关。将该产品的重要用户类与那些不太重要的用户类区分开。
2.4 运行环境
描述了软件的运行环境,包括硬件平台、操作系统和版本,还有其他的软件组件或与其共存的应用程序。
2.5 设计和实现上的限制
确定影响开发人员自由选择的问题,并说明这些问题为什么成为一种限制。可能的限制包括以下内容:
l 必须使用或者避免的特定技术、工具、编程语言和数据库。
l 所要求的开发规范或标准(例如,如果有客户的公司负责软件维护,就必须定义转包者所使用的设计符号表示和编码标准。
l 企业策略、政府法规或工业标准。
l 硬件限制,例如定时需求或存储器限制。
l 数据转换格式标准。
2.6 假设和依赖
列举出在对软件需求规格说明中影响需求陈述的假设因素(与已知因素相对立)。可能包括打算要用的商业组件或有关开发或运行环境的问题。你可能认为产品将符合一个特殊的用户界面设计约定,但是另一个SRS读者却可能不这样认为。如果这些假设不正确、不一致或被更改,就会使项目受到影响。
此外,确定项目对外部因素存在的依赖。例如,如果你打算把其他项目开发集成到系统中,那么你就要依赖那个项目按时提供正确的操作组件。如果这些依赖已经记录到其他文档(例如项目计划)中了,那么在此就可以参考其他文档。
3 外部接口需求
本节确定可以保证新产品与外部组件正确连接的需求。关联图表示了高层抽象的外部接口。需要把对接口数据和控制组件的详细描述写入数据字典中。如果产品的不通部分有不同的外部接口,那么应该把这些外部接口的详细需求并入到这一部分的实例中。
3.1 用户界面
陈述所需要的用户界面的软件组件。描述每个用户界面的逻辑特征。以下是可能要包括的一些特征:
l 将要采用的图形用户界面(GUI)标准或产品系列的风格
l 屏幕布局或解决方案的限制
l 将出现在每个屏幕的按钮、功能或导航链结(例如一个帮助按钮)。
l 快捷键
l 错误信息显示标准
对于用户界面的细节,例如特定对话框的布局,应该写入一个独立的用户界面规格说
明中,而不能写入软件需求规格说明中。
3.2 硬件接口
描述系统中软件和硬件每一接口的特征。这种描述可能包括支持的硬件类型、软硬件之间交流的数据和控制信息的性质以及所使用的通信协议。
3.3 软件接口
描述该产品与其他外部组件(由名字和版本识别)的连接,包括数据库、操作系统、工具、库和集成的商业组件。明确并描述在软件组件之间交换数据或消息的目的。描述所需要的服务以及内部组件通信的性质。确定将在组件之间共享的数据。如果必须用一种特殊的方法来实现数据共享机制,例如在多任务操作系统中的一个全局数据区,那么就必须把它定义为一种实现上的限制。
3.4 通信接口
描述与产品所使用的通信功能相关的需求,包括电子邮件、Web浏览器、网络通信标准或协议及电子表格等等。定义了相关的消息格式。规定通信安全或加密问题、数据传输速率和同步通信机制。
4 系统特性
在模板中,功能需求是根据系统特性即产品所提供的主要服务来组织的。你可能更喜欢通过使用实例、运行模式、用户类、对象类或功能等级来组织这部分内容(IEEE1998)。你还可以使用这些元素的组合。总而言之,你必须选择一种使读者易于理解预期产品的组织方案。
仅用简短的语句说明特性的名称,例如“4.1拼写检查和拼写字典管理”。无论你想说明何种特性,阐述每种特性时都将重复从4.1到4.3这三步系统特性。
4.1 说明和优先级
提出了对该系统特性的简短说明并指出该特性的优先级是高、中,还是低。或者你还可以包括对特定优先级部分的评价,例如利益、损失、费用或风险,其相对优先等级还可以从1(低)到9(高)。
4.2 激励/响应序列
列出输入激励(用户动作、来自外部设备的信号或其他触发器)和定义这一特性行为的系统响应序列。这些序列将与使用实例相关的对话元素相对应。