软件需求规格说明书模版.docx

软件需求规格说明书模版软件需求规格说明书模版文件变化记录单版本编号*变化状态简要说明变更人变更日期批准人批准日期*变化状态：A增加，M修改，D删除文件批准单职务签字日期1. 引言提出对软件需求规格说明书的纵览，帮助读者理解文档如何编写而且如何阅读和解释。1.1 编写目的对产品（也可能是项目，可是我们统称为产品）进行定义，在该文档中详尽说明这个产品的软件需求，包括修正或发行版本号。如果这个软件需求规格说明书只与整个系统的一部分有关，那么只定义文档中说明的部分或子系统。1.2 文档约定描述编写文档时所采用的标准或排版约定，包括正文风格、提示区或重要符号。例如，说明高层需求的优先级是否能够被其所有细化的需求所继承，或者每个需求陈述是否都有优先级。1.3 预期的读者和阅读建议列举软件需求规格说明书所针正确不同读者，例如开发人员、项目经理、营销人员、用户、测试人员等。描述文档中剩余部分的内容及其组织结构。提出最适合每一类型读者阅读文档的建议。1.4 产品的范围提供对指定的软件及其目的的简短描述，包括利益和目标。把软件与企业目标或业务策略相联系。能够参考项目范围文档，而不是将其内容复制到这里。1.5 参考资料列举编写软件需求规格说明书时所参考的资料或其它来源。可能包括用户界面风格指导、合同、标准、系统需求规格说明书、用户需求、相关产品的软件需求规格说明书。这里应该给出详细的信息，包括标题名称、作者、版本号、日期、出版单位或资料来源，以方便读者查阅这些文献。2. 综合描述这一部分概述了正在定义的产品以及它所运行的环境、使用产品的用户和已知的限制、假设和依赖。2.1 产品的前景描述软件需求规格说明书中所定义的产品的背景和起源。说明该产品是否是产品系列中的下一个成员，是否是成熟产品所改进的下一代产品、是否是现有应用程序的替代品，或者是否是一个全新的产品。如果软件需求规格说明书定义了大系统的一个组成部分，那么就要说明这部分软件是怎样与整个系统相关联的，而且要定义出两者之间的接口。建议使用系统结构图或者实体关系图表示。2.2 产品的功能概述产品所具有的主要功能，详细内容在第4节描述，因此这里只需要概括总结，例如用列表的方法给出。很好地组织产品的功能，使每个读者都易于理解。用图形表示主要的需求分组以及它们之间的联系。建议使用数据流程图（DFD）的顶层图或类图来实现图形化。2.3 用户类和特征确定可能使用该产品的不同用户类并描述它们相关的特征。有一些需求可能只与特定的用户类相关。将该产品的重要用户类与那些不太重要的用户类区分开。2.4 运行环境描述软件的运行环境，包括硬件平台、操作系统和版本，还有其它的软件组件或者与其共存的应用程序。2.5 设计和实现上的限制确定影响开发人员自由选择的问题，并说明这些问题为什么成为一种限制。可能的限制包括：w 必须使用或者避免的特定技术、工具、编程语言、数据库；w 经费、进度、资源等方面的限制；w 所要求的开发规范或标准；w 企业策略、政府法规或工业标准；w 硬件限制，例如定时需求或存储器限制；w 数据转换格式标准。w 其它。2.6 假设和依赖列举出在对软件需求规格说明书影响需求陈述的假设因素。可能包括打算要用的商业组件或有关开发或运行环境的问题。你可能认为产品将符合一个特殊的用户界面设计约定，可是另外一个分析员却不这么认为。如果这些假设不正确、不一致或者被更改，都会使项目受到影响。另外，确定项目对外部因素存在的依赖。例如，如果你打算把其它项目开发的组件集成到系统中，那么你就要依赖哪个项目能否按时提供正确的组件。如果这些依赖已经记录到其它文档（如项目计划）中了，那么在此就能够参考其它文档。2.7 关键点说明本软件需求规格说明书中的关键点（例如：关键功能、关键算法和所涉及的关键技术等）。3. 外部接口需求确定能够保证新产品与外部组件正确连接的需求。关联图表示了高层抽象的外部接口。需要把对接口数据和控制组件的详细描述写入数据字典中。如果产品的不同部分有不同的外部接口，那么应该把这些外部接口的详细要求并入到这一部分的实例中。3.1 用户界面陈述所需要的用户界面的软件组件。描述每个用户界面的逻辑特征。以下是可能要包括的一些特征：w 将要采用的图形用户界面标准或产品系列的风格；w 屏幕布局或解决方案的限制；w 将出现在每个屏幕的标准按钮、功能或导航链接；w 快捷键；w 错误信息显示标准。对于用户界面的细节，例如特定对话框的布局，建议写入一个独立的用户界面规格说明中，不要写入软件需求规格说明书中。3.2 硬件接口描述系统中软件和硬件每个接口的特征。可能包括支持的硬件类型、软硬件之间交流的数据和控制信息的性质以及所使用的通信协议。3.3 软件接口描述产品与其它外部组件（由名字和版本识别）的连接，包括数据库、操作系统、工具、库和集成的商业组件。明确并描述在软件组件之间交换数据或信息的目的，描述所需要的服务以及内部组件通信的性质，确定将在组件之间共享的数据。如果必须用一种特殊的方法来实现数据共享机制，那么就必须把它定义为一种实现上的限制。3.4 通信接口描述与产品所使用的通信功能相关的需求，包括电子邮件、WEB浏览器、网络通信标准或协议及电子表格等，定义相关的信息格式、规定通信安全或加密问题、数据传输速率和同步通信机制。4. 功能需求4.1 功能分类将功能性需求先粗分再细分，下表中的 Feature A, Function A.1等符号应当被替换成有含义的名称。也能够用功能结构图表示功能类别功能Feature AFunction A.1Function A.2Feature BFunction B.1Function B.24.2 系统特性Feature A 4.2.1 说明和优先级提出对该系统特性的简短说明并指出该特性的优先级是高、中还是低。4.2.2 功能需求详细列出与该特性相关的功能需求。这些是必须提交给用户的软件功能，使用户能够使用所提供的特性执行服务或者使用所指定的用例执行任务。描述产品如何响应可预知的出错条件或非法输入或动作。4.2.2.1 功能 function A.1（1）说明本功能的简要说明（2）角色 本功能的执行人员（3）前置条件 该功能启动的前提条件（4）输入描述本功能的输入信息（包括需要访问的存储信息）。（5）过程对本功能将做什么进行详细的描述。（6）输出描述本功能的输出信息（包括需要访问的存储信息）。（7）后置条件 该功能结束的退出条件（8）业务规则列举出与该功能相关的操作规则。例如什么人在特定环境下能够进行何种操作。4.2.2.2 function A.1 图书借阅（1）说明借阅人经过此功能向系统查询并提交借书请求（2）角色 借阅人（3）前置条件w 借阅人借阅证件在有效期内w 借阅人没有逾期未归还的图书（4）输入借阅证（5）过程主过程描述1用户用借阅证提供的帐号登录系统，系统显示我的图书馆界面2.用户选择查询图书，系统显示查询界面3.用户按书名、作者、出版社查询，系统显示查询结果4.用户可单选或多选书本，并确认借阅。系统显示确认借阅图书清单。5.用户选择确认借阅，系统显示借阅定单及费用6用户选择提交定单，系统显示提交结果和定单号7.系统执行后置条件分支过程描述2.1.1用户选择查看原有定单，系统执行4;4.1.1用户可单选或多选书本，放入借书篮，系统显示借书篮现有内容4.1.2.1.1用户选择继续借书，系统执行2；4.1.2.2.1用户选择提交借书篮，系统执行44.2.1 用户选择放弃，系统执行2；6.1.1用户选择保存定单，系统保存并执行1；6.2.1用户选择放弃，系统执行1；异常过程描述1.1.1借阅证已过期，拒绝登录，结束1.2.1借阅人有逾期未归还书本，启动“归还图书”功能5.1.1用户余额不足，系统显示余额和所需金额5.1.2.1.1用户选择续费，启动“交纳借阅费”功能5.1.2.2.1用户选择放弃，系统执行1（6）输出费用记录借阅定单（7）后置条件w 创立借书定单w 更新借阅人借阅记录（8）业务规则每次每人至少选择一本,至多选择三本4.3 系统特性Feature B 5. 非功能需求5.1 性能需求阐述不同的应用领域对产品性能的需求，并解释它们的原理以帮助开发人员做出合理的设计选择。确定相互合作的用户数或者所支持的操作、响应时间以及与实时系统的时间关系；还要定义容量需求，例如存储器和磁盘空间的需求或者存储在数据库中表的最大行数。也可能需要针对每个功能需求或特性分别陈述其性能需求，而不是把它们集中在一起陈述。例如：“在运行WINDOWS 的450MHZ Pentium II 的计算机上，当系统至少有50%的空闲资源时，95%的目录数据库查询必须在两秒内完成”。5.2 安全性需求陈述与系统安全性、完整性或私人问题相关的需求，这些问题将会影响到产品的使用和产品所创立或使用的数据的保护。明确产品必须满足的安全性或保密性策略。一个软件系统的安全需求的范例如下：“每个用户在第一次登录之后，必须更改她的最初登录密码。最初的登录密码不能重用。”5.3 软件质量属性详尽陈述与客户或开发人员至关重要的质量特性。这些特性必须是确定、定量的并可验证的。至少应指明不同属性的相对侧重点，例如易用程度优于易学程度，或者可移植性优于有效性。5.4 其它需求定义至今未出现的需求。例如国际化需求、法律上的需求、有关操作、管理、维护、安装、配置、启动、关闭、修复、容错、登录、监控等等方面的需求。说明本产品在可使用性、可维护性、可移植性、可靠性和安全性等方面的要求。6. 数据字典6.1 实体关系图6.2 实体定义指出数据项名、定义、项结构组成、项范围、项类型。实体名称Be_图书实体描述每本图书都经有上架，预定，借出，返回待查和下架几个状态，详细请参看图书状态图属性名称类型精度说明(属性的业务含义及业务规则)图书编号字符12图书类别编号(3位)+图书购入年份(4位)+流水号(5)位图书分类字符3图书的分类名称字符100书本的封面名称作者字符20书籍的作者出版社字符100书籍标明的出版社出版日期日期书籍标明的出版日期版本信息字符100书籍标明的出版社简介字符1000书籍的内容简介，上架时录入状态字符1书籍的状态，请参看图书状态图7. 业务规则与业务算法7.1 业务规则列举出有关产品的所有操作规则。例如什么人在特定环境下能够进行何种操作。这些规则不是功能需求，但它们能够暗示某些功能需求执行这些规则。业务规则的范例如下：“只有持有管理员密码的用户才能执行100元以上的退款操作”。借出规则说明: 读者已借书数未超过最大借书数、该书有库存，而且该读者拥有借阅该书的权限，则执行该操作。罚款规则说明：1.超期罚款：超期天数超期罚款率。2.丢失罚款：图书价格丢失赔率7.2 算法说明用于实施系统计算功能的公式和算法的描述，类似于业务规则。如某神州行套餐的计费标准说明。a.每个主要算法的概况；b.用于每个主要算法的详细公式。附录A：分析模型（也能够纳入 4功能需求章节中描述）包括或涉及到相关的分析模型的位置，例如数据流图、类图、状态转换图等。顶层数据流图：第1层数据流图：第2层数据流图：附录B：待确定问题的列表编辑一张在软件需求规格说明书中待确定问题的列表，其中每一表项都是编上号的，以便跟踪调查。附录C：编写文档的原则编写文档时，要求具有本规范规定的所有条目如果某条目无内容，则填写“无”，并在可能的情况下说明理由。必要时，可增加适当的条目。编写优秀的需求文档没有现成固定的方法，最好是根据经验进行。许多需求文档能够经过使用有效的技术编写风格和使用用户术语而不是技术术语的方式得以改进。你在编写需求文档时，应牢记以下几点建议： 保持语句和段落的简短； 采用主动语态的表示方式； 语法正确，句子完整； 使用的术语与词汇表中所定义的术语一致； 避免模糊的、主观的术语如用户友好、容易、简单、迅速、有效、许多、最新技术、优越的、可接受的、健壮的等等； 避免使用比较性的词汇如提高、最大化、最小化、最佳化等。定量说明所需要提高的程度或者说清一些参数能够接受的最大值和最小值。含糊的语句表示将引起需求的不可验证。 由于需求的编写是层次化的，因此，能够把顶层不明确的需求向低层详细分解，直到消除不明确性为止。编写详细的需求文档，所带来的益处是如果需求得到满足，那么客户的目的也就达到了，可是不要让过于详细的需求影响了设计。如果你能用不同的方法来满足需求，而且这种方法是可接受的，那么需求的详细程度也就足够了。然而，如果评审需求规格说明书的设计人员对客户的意图还不甚了解，那么就需要增加额外的说明，以减少由于误解而产生返工的风险。 需求文档的编写人员总是力求寻找到恰如其分的需求详细程度。一个有益的原则就是编写单个的可测试需求文档。如果你想出一些相关的测试用例能够验证这个需求，那么就达到了合理的详细程度。如果你预想的测试很多而且很分散，那么就要将一些集合在一起的需求分离开。 必须以相同的详细程度编写每个需求文档。 不应该把多个需求集中在一个冗长的叙述段落中。在需求中，诸如“和”，“或”之类的连词就表明了该部分集中了多个需求。不要在需求说明中使用“和/或”，“等等”之类的连词。 不应该出现需求的冗余。