需求工程之需求规格说明文档模板内容

  1. 引言
    提出对软件需求规格说明的纵览,帮助读者理解该文档是如何编写并且如何阅读和解释。
  2. 编写目的
    对产品进行定义,在该文档中详尽说明该产品的软件需求,包括修正或发行版本号。如果该软件需求规格说明只与整个系统的一部分有关系,那么就只定义文档中说明的部分或子系统。
  3. 文档约定
    描述编写文档时所采用的标准或排版约定,包括正文风格、提示区或重要符号。例如,说明高层需求的优先级是否可以被其所有细化的需求所继承,或者每个需求陈述是否都有其自身的优先级。
  4. 背景
    说明待开发的软件系统的名称;本项目的任务提出者、开发者、用户以及实现该软件的计算中心或者计算机网络。
  5. 预期的读者和阅读建议
    列举软件需求规格说明所针对的不同读者。例如开发人员、项目经理、营销人员、用户、测试人员或文档编写人员。描述文档中剩余部分的内容及其组织结构,提出最适合于每一类型读者阅读文档的建议。
  6. 定义
    列出本文件中用到的专门术语的定义,外文首字母组词的原词组。
  7. 产品的范围
    提供对指定的软件及其项目的简短描述,包括利益和目标。把软件与企业目标或业务策略相联系。可以参考项目视图和范围文档而不是将其内容复制到这里。
  8. 参考资料
    列举编写软件需求规格说明时所参考的资料或其他资源。可能包括用户界面风格指导、合同、标准、系统需求规格说明、使用实例文档,或相关产品的软件需求规格说明,此处应给出详细的信息,包括标题的名称、作者、版本号、日期、出版单位或资料来源,以方便读者查阅这些文献。例如,本项目的经核准的计划任务书或者合同或者上级机关的批文;属于本项目的其他已发表的文件;本文件中各处引用的文件、资料,包括要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期、出版单位,说明能够得到这些文件资料的来源。
  9. 目标
    叙述软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关软件开发的背景材料。解释开发软件与其他软件之间的关系。如果本软件产品是一项独立的软件,而且全部内容包含,则说明这一点。如果所定义的产品是一个更大的系统的一个组成部分,则应说明本产品与该系统中其他各组成部分之间的关系,为此可以使用一张方框图来说明该系统的组成和本产品同其他各部分的联系和接口。
  10. 用户的特点
    列出本软件的最终用户的特点,充分说明操作人员、维护人员的教育水平和技术专长,以及本软件的预期使用额度。这些是软件设计工作的重要约束。
  11. 假定和约束
    列出本软件开发工作的假定和约束,例如经费限制、开发期限等。
  12. 综合描述
    概述正在定义的产品以及它所运行的环境、使用产品的用户和已知的限制、假设和依赖。
  13. 产品的前景
    描述软件需求规格说明中所定义的产品的背景和起源。说明该产品是否是产品系列中的下一成员,是否是成熟产品所改进的下一代产品、是否是现有应用程序的替代品,或者是否是一个新型的、自含型产品。如果软件需求规格说明定义了大系统的一个组成部分,那么就要说明这部分软件是怎样与整个系统相关联的,并且要定义出两者之间的接口。
  14. 产品的功能
    概述产品所具有的主要功能。其详细内容将在后续章节中描述,所以此处只需要概括地总结。例如用列表的方法给出。很好组织产品的功能,使每个读者都易于理解。用图形表示主要的需求分组以及他们之间的联系,例如数据流程图的顶层图或类图,都可以。
  15. 用户类和特征
    确定可能使用该产品的不同用户类并描述他们相关的特征。有些需求可能只与特定的用户类相关。将该产品的重要用户类与那些不太重要的用户类区分开。
  16. 运行环境
    描述软件的运行环境,包括硬件平台、操作系统和版本,还有其他的软件组件或与其共存的应用程序。
  17. 设计和实现上的限制
    确定影响开发人员自由选择的问题,并说明这些问题为什么成为一种限制。可能的限制包括以下内容:必须使用或者避免的特定技术、工具、编程语言和数据库。所要求的开发规范或标准(例如,如果有客户的公司负责软件维护,就必须定义转包者所使用的设计符号表示和编码标准。企业策略、政府法规或工业标准。硬件限制,例如定时需求或存储器限制。数据转换格式标准。
  18. 假设和依赖
    列举在对软件需求规格说明中影响需求陈述的假设因素(与已知因素相对立)。可能包括打算要用的商业组件或有关开发或运行环境的问题。可能认为产品将符合一个特殊的用户界面设计约定,但是另一个 SRS 读者却可能不这样认为。如果这些假设不正确、不一致或被更改,就会使项目受到影响。此外,确定项目对外部因素存在的依赖。例如,如果打算把其他项目开发集成到系统中,那么就要依赖那个项目按时提供正确的操作组件。如果这些依赖已经记录到其他文档(例如项目计划)中了,那么在此就可以参考其他文档。
  19. 外部接口需求
    确定可以保证新产品与外部组件正确连接的需求。关联图表示了高层抽象的外部接口。需要把对接口数据和控制组件的详细描述写入数据字典中。如果产品的不同部分有不同的外部接口,那么应该把这些外部接口的详细需求并入到这部分的实例中。
  20. 用户界面
    陈述所需要的用户界面的软件组件。描述每个用户界面的逻辑特征。可能包括的一些特征如,将要采用的图形用户界面(GUI)标准或产品系列的风格;屏幕布局或解决方案的限制;将出现在每个屏幕的按钮、功能或导航链结(例如一个帮助按钮);快捷键;错误信息显示标准对于用户界面的细节,比如特定对话框的布局,应该写入一个独立的用户界面规格说明中,而不能写入软件需求规格说明中。
  21. 硬件接口
    描述系统中软件和硬件每一接口的特征。这种描述可能包括支持的硬件类型、软硬件之间交流的数据和控制信息的性质以及所使用的通信协议。
  22. 软件接口
    描述该产品与其他外部组件(由名字和版本识别)的连接,包括数据库、操作系统、工具、库和集成的商业组件。明确并描述在软件组件之间交换数据或消息的目的。描述所需要的服务以及内部组件通信的性质。确定将在组件之间共享的数据。如果必须用一种特殊的方法来实现数据共享机制,例如在多任务操作系统中的一个全局数据区,那么就必须把它定义为一种实现上的限制。
  23. 通信接口
    描述与产品所使用的通信功能相关的需求,包括电子邮件、Web 浏览器、网络通信标准或协议及电子表格等等。定义相关的消息格式。规定通信安全或加密问题、数据传输速率和同步通信机制。
  24. 系统特性
    在模板中,功能需求是根据系统特性即产品所提供的主要服务来组织的。可通过使用实例、运行模式、用户类、对象类、功能等级,或这些元素的组合来组织这部分内容(IEEE1998)。总而言之,必须选择一种使读者易于理解预期产品的组织方案。另外,仅用简短的语句说明特性的名称,例如“4.1 拼写检查和拼写字典管理”。
  25. 说明和优先级
    提出对该系统特性的简短说明并指出该特性的优先级是高、中,还是低。或者还可以包括对特定优先级部分的评价,例如利益、损失、费用或风险,其相对优先等级还可以从 1(低)到 9(高)。
  26. 激励/响应序列
    列出输入激励(用户动作、来自外部设备的信号或其他触发器)和定义这一特性行为的系统响应序列。这些序列将与使用实例相关的对话元素相对应。
  27. 功能需求
    详列出与该特性相关的详细功能需求。是必须提交给用户的软件功能,使用户可使用所提供的特性执行服务或者使用所指定的使用实例执行任务。描述产品如何响应可预知的出错条件或者非法输入或动作。必须唯一地标示每一个需求。
  28. 非功能需求
    列举出所有非功能需求,而不是外部接口需求和限制。
  29. 性能需求
    阐述不同的应用领域对产品性能的需求,并解释它们的原理以帮助开发人员做出合理的设计选择。确定相互合作的用户数或者所支持的操作、响应时间以及与实时系统的时间关系。可在此处定义容量需求,例如存储器和磁盘空间的需求或者存储在数据库中表中的最大行数。尽可能详细地确定性能需求。可能需要针对每个功能需求或特性分别陈述其性能需求,而不是把它们都集中在一起陈述。例如,“在运行微软 Windows 2000 的 450 MhzPentium II 的计算机上,当系统至少有 50%的空闲资源时,95%的目录数据库查询必须在两秒内完成。”
  30. 安全设施需求
    详尽陈述与产品使用过程中可能发生的损失、破坏或危害相关的需求。定义必须采取的安全保护或动作,以及应预防的潜在的危险动作。明确产品必须遵从的安全标准、策略或规则。一个安全设施需求的范例如下:“如果油箱的压力超过了规定的最大压力的 95%,那么必须在 1 秒中内终止操作。”
  31. 安全性需求
    详尽陈述与系统安全性、完整性或与私人问题相关的需求,这些问题将会影响到产品的使用和产品所创建或使用的数据的保护。定义用户身份确认或授权需求。明确产品必须满足的安全性或保密性策略,用“完整性”的质量属性来阐述这些需求。一个软件系统的安全性需求的范例如下:“每个用户在第一次登录后,必须更改他的最初登录密码。最初的登录密码不能重用。”
  32. 软件质量属性
    详尽陈述与客户或开发人员至关重要的其他产品质量特性。这些特性必须是确定、定量,并在可能时可验证。至少应指明不同属性的相对侧重点。例如易用程度优于易学程度,或者可移植性优于有效性。
  33. 业务规则
    列举出有关产品的所有操作规则,例如什么人在特定的环境下可以进行何种操作。这些本身不是功能需求,但它们可以暗示某些功能需求执行这些规则。一个业务规则的范例如下:“只有持有管理员密码的用户才能执行¥100.00 或更大额的退款操作。”
  34. 用户文档
    列举出将与软件一同发行的用户文档部分。例如,用户手册、在线帮助和教程。明确所有已知的用户文档的交付格式或标准。
  35. 其他需求
    定义在软件需求规格说明的其他部分未出现的需求,例如国际化需求或法律上的需求。还可以增加有关操作、管理和维护部分来完善产品安装、配置、启动和关闭、修复和容错,以及登录和监控操作等方面的需求。在模板中加入与本系统相关的新部分。果不需要增加其它需求,就省略这一部分。
  36. 附录 A:词汇表
    定义所有必要的术语,以便读者可以正确地解释软件需求规格说明,包括词头和缩写。可为整个公司创建一张跨多项项目的词汇表,并且只包括特定于单一项目的软件需求规格说明中的术语。
  37. 附录 B: 分析模型
    这个可选部分包括后文涉及到相关的分析模型的位置,例如数据流程图、类图、状态转换图或实体关系图,以及查阅这些图的位置说明。
  38. 附录 C:待确定问题的列表
    编辑一张在软件需求规格说明中待确定的问题的列表,其中每一表项都是编号的,以便于跟踪调查。

发布了72 篇原创文章 · 获赞 3 · 访问量 3537

猜你喜欢

转载自blog.csdn.net/id__39/article/details/105262120