软件需求分析报告文档模板

附录A 软件需求分析报告文档模板 1. 引言    11 1.1 编写目的    11 1.2 项目风险    11 1.3 文档约定    11 1.4 预期读者和阅读建议    11 1.5 产品范围    12 1.6 参考文献    12 2. 综合描述    12 2.1 产品的状况    12 2.2 产品的功能    13 2.3 用户类和特性    13 2.4 运行环境    13 2.5 和实现上的限制    13 2.6 假设和约束(依赖)    14 3. 外部接口需求    14 3.1 用户界面    14 3.2 硬件接口    15 3.3 软件接口    15 3.4 通讯接口    16 4. 系统功能需求    16 4.1 说明和优先级    16 4.2 激励／响应序列    17 4.3 输入／输出数据    17 5. 其它非功能需求    17 5.1 性能需求    17 5.2 安全措施需求    18 5.3 安全性需求    18 5.4 软件质量属性    18 5.5 业务规则    18 5.6 用户文档    18 6. 词汇表    19 7. 数据定义    19 8. 分析模型    20 9. 待定问列表    20 1. 引言 引言是对这份软件产品需求分析报告的概览，是为了帮助阅读者了解这份文档是如何编写的，并且应该如何阅读、理解和解释这份文档。 1.1 编写目的 说明这份软件产品需求分析报告是为哪个软件产品编写的，开发这个软件产品意义、作用、以及最终要达到的意图。通过这份软件产品需求分析报告详尽说明了该软件产品的需求规格，包括修正和(或)发行版本号，从而对该软件产品进行准确的定义。 如果这份软件产品需求分析报告只与整个系统的某一部分有关系，那么只定义软件产品需求分析报告中说明的那个部分或子系统。 1.2 项目风险 具体说明本软件开发项目的全部风险承担者，以及各自在本阶段所需要承担的主要风险，首要风险承担者包括： l 任务提出者； l 软件开发者； l 产品使用者。 1.3 文档约定 描述编写文档时所采用的(如果有标准的话)，或者各种排版约定。排版约定应该包括： l 正文风格； l 提示方式； l 重要符号； 也应该说明高层次需求是否可以被其所有细化的需求所继承，或者每个需求陈述是否都有其自己的优先级。 1.4 预期读者和阅读建议 列举本软件产品需求分析报告所针对的各种不同的预期读者，例如，可能包括： l 用户； l 开发人员； l 项目经理； l 营销人员； l 测试人员； l 文档编写入员。 并且描述了文档中，其余部分的内容及其组织结构，并且针对每一类读者提出最适合的文档阅读建议。 1.5 产品范围 说明该软件产品及其开发目的的简短描述，包括利益和目标。把软件产品开发与企业目标，或者业务策略相联系。 描述产品范围时需注意，可以参考项目视图和范围文档，但是不能将其内容复制到这里。 1.6 参考文献 列举编写软件产品需求分析报告时所用到的参考文献及资料，可能包括： l 本项目的书； l 上级机关有关本项目的批文； l 本项目已经批准的计划任务书； l 用户界面风格指导； l 开发本项目时所要用到的标淮； l 系统规格需求说明； l 使用实例文档； l 属于本项目的其它己发表文件； l 本软件产品需求分析报告中所引用的文件、资料； l 相关软件产品需求分析报告； 为了方便读者查阅，所有参考资料应该按一定顺序排列。如果可能，每份资料都应该给出： l 标题名称； l 作者或者合同签约者； l 文件编号或者版本号； l 发表日期或者签约日期； l 出版单位或者资料来源。 2. 综合描述 这一部分概述了正在定义的软件产品的作用范围以及该软件产品所运行的环境、使用该软件产品的用户、对该软件产品己知的限制、有关该软件产品的假设和依赖。 2.1 产品的状况 描述了在软件产品需求分析报告中所定义的软件产品的背景和起源。说明了该软件产品是否属于下列情况： l 是否是产品系列中的下一成员； l 是否是成熟产品所改进的下一代产品； l 是否是现有应用软件的替代品(升级产品)； l 是否是一个新型的、自主型的产品。 如果该软件产品需求分析报告定义的软件系统是： l 大系统的一个组成部分； l 与其它系统和其它机构之间存在基本的相互关系。 那么必须说明软件产品需求分析报告定义的这部分软件是怎样与整个大系统相关联的，或者（同时）说明相互关系的存在形式，并且要定义出两者之间的全部接口。 2.2 产品的功能 因为将在需求分析报告的第4部分中详细描述软件产品的功能，所以在此只需要概略地总结。仅从业务层面陈述本软件产品所应具有的主要功能，在描述功能时应该针对每一项需求准确地描述其各项规格说明。如果存在引起误解的可能，在陈述本软件产品主要功能的作用领域时，也需要对应陈述本软件产品的非作用领域，以利读者理解本软件产品。 为了很好地组织产品功能，使每个读者都容易理解，可以采用列表的方法给出。也可以采用图形方式，将主要的需求分组以及它们之间的联系使用数据流程图的顶层图或类图进行表示，这种表示方法是很有用的。 参考用户当前管理组织构架，了解各个机构的主要职能，将有助于陈述软件产品的主要功能。 2.3 用户类和特性 确定有可能使用该软件产品的不同用户类，并且描述它们相关的特征。往往有一些软件需求，只与特定的用户类有关。描述时，应该将该软件产品的重要用户类与非重要用户类区分开。 用户不一定是软件产品的直接使用者，通过报表、应用程序接口、系统硬件接口得到软件产品的数据和服务的人、或者机构也有他们的需求。所以，应该将这些外部需求视为通过报表、应用程序接口、系统硬件接口附加给软件产品的附加用户类。 2.4 运行环境 描述了本软件的运行环境，一般包括： l 硬件平台； l 操作系统和版本； l 支撑环境(例如：数据库等)和版本； l 其它与该软件有关的软件组件； l 与该软件共存的应用程序。 2.5 设计和实现上的限制 确定影响开发人员自由选择的问题，并且说明这些问题为什么成为一种限制。可能的限制包括下列内容： l 必须使用的特定技术、工具、编程语言和数据库； l 避免使用的特定技术、工具、编程语言和数据库； l 要求遵循的开发规范和标准 例如，如果由客户的公司或者第三方公司负责软件维护，就必须定义转包者所使用的设计符号表示和编码标准； l 企业策略的限制； l 政府法规的限制； l 工业标准的限制； l 硬件的限制 例如，定时需求或存储器限制； l 数据转换格式标淮的限制。 2.6 假设和约束(依赖) 列举出对软件产品需求分析报告中，影响需求陈述的假设因素(与己知因素相对立)。如果这些假设因素不正确、不一致或者被修改，就会使软件产品开发项目受到影响。这些假设的因素可能包括： l 计划使用的商业组件，或者其它软件中的某个部件； l 假定产品中某个用户界面将符合一个特殊的设计约定； l 有关本软件用户的若干假定(例如：假定用户会熟练使用SQL语言。)； l 有关本软件开发工作的若干假定(例如：用户承诺的优惠、方便、上级部门给予的特殊政策和支持等。)； l 有关本软件运行环境的一些问题； 此外，确定本软件开发项目对外部约束因素所存在的依赖。有关的约束可能包括： l 工期约束； l 经费约束； l 人员约束； l 设备约束； l 地理位置约束； l 其它有关项目约束； 3. 外部接口需求 通过本节描述可以确定，保证软件产品能和外部组件正确连接的需求。关联图仅能表示高层抽象的外部接口，必须对接口数据和外部组件进行详细描述，并且写入数据定义中。如果产品的不同部分有不同的外部接口，那么应该把这些外部接口的全部详细需求并入到这一部分实例中。 注意：必须将附加用户类的特征与外部接口需求加以区分，附加用户类的特征描述的是通过接口取得软件产品的数据和服务的人的需求；而外部接口需求描述的是接口本身的需求。 3.1 用户界面 陈述需要使用在用户界面上的软件组件，描述每一个用户界面的逻辑特征。必须注意，这里需要描述的是用户界面的逻辑特征，而不是用户界面。以下是可能包括的一些特征： l 将要采用的图形用户界面(GUl)标准或者产品系列的风格； l 有关屏幕布局或者解决的限制； l 将要使用在每一个屏幕(图形用户界面)上的软件组件，可能包括： ? 选单； ? 标准按钮； ? 导航链接； ? 各种功能组件； ? 消息栏； l 快捷键； l 各种显示格式的规定，可能包括： ? 不同情况下文字的对齐方式； ? 不同情况下数字的表现格式与对齐方式 ? 日期的表现方法与格式； ? 计时方法与时间格式； ? 等等。 l 错误信息显示标准； 对于用户界面的细节，例如：一个特定对话框的布局，应该写入具体的用户界面设计说明中，而不能写入软件需求规格说明中。 如果采用现成的、合适的用户界面设计规范(标准)，或者另文描述，可以在这里直接说明，并且将其加入参考文献。 3.2 硬件接口 描述待开发的软件产品与系统硬件接口的特征，若有多个硬件接口，则必须全都描述。接口特征的描述内容可能包括：