需求说明文档模板4.0(珍藏版)

TITLETITLE数字商务平台需求说明书（版本号：V2.4）[模板中所有设置为蓝色斜体的文字都是对某个部分的说明，在编写文档时需要删除这些文字]2005年1月20日

目录TOC\w\x\f\o"1-9"目录 2需求变更 31引言 31.1编写目的 31.2背景 32任务概述 42.1目标 42.2假定和约束 43详细需求 43.1网站访问流量统计分析 43.1.1需求定义 43.1.2需求描述 实体关系图 实体数据项 实体状态转换图 页面流转图 73.1.3用例说明 8前台 8后台 8导出网站访问日志 93.1.4性能说明 104功能变更[可裁减] 10需求变更[目的与内容]记录本文档修改的历史，主要是详细需求和功能变更的修改。[方式]表格序号需求编号变更内容变更原因变更时间提出者修改者1引言1.1编写目的[目的与内容]说明编写这份软件需求说明书的目的，包括：（1）整体目的；（2）预期读者；（3）给读者带来的价值。此文档定义了数字商务平台2.0版本新增功能的需求规格。文档的主要读者为产品部、项目组应用系统分析师和测试部。产品部通过阅读该文档以确认需求分析文档的描述与产品部提出的需求的一致性。项目组应用系统分析师通过阅读该文档以明确需求实现任务中说明的功能需求和性能需求等。测试部通过阅读该文档以明确需求说明中提供给用户的实现功能、操作流程以及验证的方式。目的是使客户、软件设计人员、软件开发人员和整合测试人员，对该版本的运行环境、功能和性能需求的初始规定有一个共同的理解，使之成为整个开发工作的基础，为用户手册的编写、概要设计以及测试用例的编写提供需求说明。1.2背景[目的与内容]说明系统开发的背景，包括：（1）任务提出者、开发者和用户；（2）立项的原因。[小例子]网上商店系统1.0版本已经运行3个月，为了提供高多的功能和更好的性能，方便用户和商店顾客使用，中国企业网根据用户的要求提出了一系列新的需求，因此需要对原1.0版本进行升级。]需要在原1.0版本的基础上增加新功能，进而升级到2.0版本。2任务概述2.1目标[目的与内容]描述本项目的开发目标，包括：应用目标、作用范围和系统边界等。本项目是在原2.3版本的基础上升级到2.4版本，必须完成需求详细需求中所有优先级为高或中的功能。如果时间允许，则同时完成优先级为低的功能。经过本次升级，数字商务平台应该能够使用户使用本软件更加简便，基本消除软件中原有的Bug。2.2假定和约束[目的与内容]描述本项目开发工作的限定条件，包括：时间、开发人员、资金等方面的限制。本项目需要在2006年3月20日之前完成全部开发和测试工作。3详细需求3.1网站访问流量统计分析[目的与内容]需求名称标识一个概要用例，它为系统用例提供分类机制。[需求负责人]夏少云[界面负责人]王英[参考资料]太极链：/武林榜：/[目的与内容]标明需求负责人和界面负责人，用以明确两者在需求整个生命周期内的责任。3.1.1需求定义业务目的[目的与内容]描述开发该项功能的目的。可以是：（1）客户/用户当前或将来遇到的问题及问题产生的原因；（2）我们想给客户提供什么样的价值或为用户带来什么样的便利。[方式]两者择其一。目前网站管理员虽然能够定义和发布各种类型的信息（如企业简介、产品广告等），但却不能准确获知如下两方面的情况：一是所发布信息的有效性；二是信息访问者的来源、分布和访问频度。或：通过为客户提供网站访问流量统计分析功能，企业可以准确地获知如下两方面的情况：一是所发布信息的有效性；二是信息访问者的来源、分布和访问频度。系统功能[目的与内容]描述系统的功能需求，这些功能使用户完成他们的任务成为现实，包括：（1）系统提供的功能；（2）功能的组织结构；[可裁减]（3）对功能实现的说明；[可裁减]（4）功能设计和布置的参考资料和间接约束，如需求文档和用户界面等。[方式]存在多个角色时，需要逐一说明提供哪些功能，此时的功能是指功能点。后台：管理员[功能列表]（1）统计流量报告：可以自由设定日期；（2）查询网站访问日志；（3）导出网站访问日志；……[功能说明]（1）后台菜单结构如下：网站访问流量统计分析――网站流量统计――流量报告――网站访问日志――分日流量统计――分月流量统计――用户访问分析――用户来路跟踪――用户来源IP分析（2）网站的累计访问人数按照Session进行计算。升级说明[目的与内容]说明升级需求，包括：（1）后台：能够自动升级新增功能；（2）前台：如何升级新增功能；（3）[方式]需要注意如下几点：（1）对修改性或补充性需求，该项不可缺；（2）对原创性的新需求，该项可缺；（3）自动升级时，常需要说明数据的初始化。后台能够实现自动升级。3.1.2需求描述实体关系图[实体说明][目的与内容]定义实体（输入和输出）的基本概念[方式]需要注意如下几点：（1）根据功能组织的顺序组织实体；（2）实体的来源：从功能的IPO（输入－处理－输出）模型出发，可大致分为三类：输入性实体、被处理的实体和输出性实体；（3）实体（输入）置于实体（输出）之前。开始统计日期：管理员设定的流量报告的统计日期。访问记录：描述访问者对网站的一次访问信息。访问记录列表：满足搜索条件的访问记录的列表。[实体关系图][目的与内容]描述实体之间可能存在的依赖、数量、组成、聚集、泛化关系，包括：（1）实体关系图（2）实体关系说明[方式]类图访问记录列表－访问记录[实体关系说明]一个访问记录列表可以对应0、1，乃至多个访问记录实体数据项[目的与内容]定义各实体中包含的数据项，包括：（1）数据项名称（2）数据项描述：定义数据项的含义，有时包含算法；（3）数据约束：非空；组成；长度；唯一；格式；关联（4)实体的访问频度和增长频度。[方式]需要注意如下几点：（1）此处实体的排列顺序与实体关系图实体说明中实体的排列顺序一致；（2）不同实体中的数据项尽可能简约一致。（3）数决约束的分类：非空约束：对输入框，约束为“是否必填”；对选择框，约束为“是否必选”；或两者兼之。元素约束：对输入框，输入内容的组成元素选择的范围，如：不区分大小写(A-Z,a-z,0-9,-,_)，必须包含“@”和“.”。长度约束：对输入框，输入内容中包含组成元素的上下限，如：不超过255个字符。格式约束：输入内容的组成元素间所应该满足的结构性要求，如：日期格式：yyyy-mm-dd。唯一约束：数据项的值在不同的实体中是否允许相同，如：网站ID。关联约束：其他数据项对当前数据项的限定，如：不能早于开始日期，必须大于当前日期2005-7-22。开始统计日期数据项名称数据项描述数据约束开始统计日期管理员设定的网站开始统计的日期必填，可选可输；最多10个字符；手动输入格式：2005－3－6；不能晚于当前日期增长频度：低访问频度：低实体状态转换图[目的与内容]定义实体状态及触发状态迁移的事件，包括：（1）状态说明；（2）状态转换图；（3）状态转换说明。[方式]状态图[例子]下面是一个“订单”的状态转换的例子订单[状态说明]订单状态分6种：已预订、已确定已付订金、已确定未付订金、入住、完成和取消，解释如下：（1）已预订：顾客提交了订单，但没有通过酒店管理员的审核且未支付订金；（2）已确定未付订金：管理员确认订单为正常信息后审核通过，此时顾客没有支付订金；（3）已确定已付订金：顾客提交订单并支付了订金，系统自动/管理员审核通过；（4）入住：顾客缴纳了订金，且已经入住；（5）完成：顾客结帐离开酒店或中途退房；（6）取消：顾客取消了预订或经管理员审核未通过。[状态转换说明]订单可操作是指订单可迁移到的状态，据订单状态转换图，结论如下：（1）已预订：审核通过——>已确定未付订金；审核未通过——>取消；取消预订——>取消；交付订金——>已确定已付订金；预订到期——>取消；//预订到期是指客人到了入住日期，仍未入住（2）已确定未付订金：支付订金——>已确定已付订金；入住——>入住；取消预订——>取消；预订到期——>取消；//预订到期是指客人到了入住日期，仍未入住（3）已确定已付订金：入住——>入住；取消预订——>取消；预订到期——>取消；//预订到期是指客人到了入住日期，仍未入住（4）入住：中途换房/结帐——>完成；完成和取消两个状态不可再迁移到其他状态。无页面流转图[目的与内容]定义页面及页面之间的流转关系，包括：（1）页面说明：页面上布置的功能与实体；如果是修改和补充性需求，只需要说明用户在该页面上可以进行什么操作或达到什么目的即可；（2）页面流转图：页面上的操作与页面之间的流转关系。（3）页面流转说明。[方式]（1）状态图；（2）除最初连线外，其余连线尽可能保持水平或竖直。前台无后台[页面参考]太极链（/）[页面说明]流量报告页面：管理员可以在该页面上查看和打印流量报告；[功能布置]查询；打印；[实体布置]开始统计日期：全部数据项可写。流量报告：全部数据项只读。[界面示意][可裁减]无[位置标注][可裁减]流量报告；流量报告打印预览页面：管理员可以在该页面上预览流量报告；[功能布置]关闭；[实体布置]流量报告：全部数据项可写。[界面示意][可裁减]无[位置标注][可裁减]打印流量报告；[页面流转图][页面流转说明]无3.1.3用例说明前台无后台[方式]被包含用例和被扩展用例在陈述时置于基本用例之前导出网站访问日志参与者：管理员[目的与内容]说明用例的执行者前提条件：管理员登陆数字商务平台后台[目的与内容]说明用例被触发前的状态初始页面：网站流量分析功能菜单[目的与内容]说明用例被触发时所在的页面[方式]（1）系统执行的用例没有初始页面；（2）有的用例可能有多个初始页面，因为该用例可以在不同的页面被触发。过程说明：[目的与内容]描述用户与系统的交互过程，包括：（1）用户操作；（2）系统响应：系统行为、页面状态、页面流转。[方式]（1）对于系统异常分支，由于测试时不可验证不必书写在过程说明中；（2）侧重于整个交互过程的主线，而不是用户和系统的行为细节；（3）如果用例涉及的页面众多或用户操作复杂，可以考虑通过关键页面将过程划分为若干阶段。管理员点击网站访问日志，系统进入网站访问日志页面，停在网站访问日志页面；在网站访问日志页面，存在如下交互：1.生成导出文件管理员点击“生成导出文件”，系统在服务器端生成导出文件，系统提示导出成功，并请求确认，停在网站访问日志页面；管理员点击确认导出成功，系统关闭信息提示，停在网站访问日志页面；2.下载管理员点击“下载”，系统提示管理员选择确定下载位置，停在网站访问日志页面；管理员选择确定下载位置，系统下载导出文件到指定位置，停在网站访问日志页面。后置条件：在指定的下载位置，得到期望的网站访问日志导出文件。[目的与内容]描述用例成功所带来的客户价值，包括：（1）用户可以看见或得到什么？（2）用户可以进一步做什么？或不可以做什么？其它说明：[目的与内容]对用例进行补充说明，可以包括如下内容：（1）用户界面细节：页面在特定系统状态下的显示的内容与格式；（2）用户或系统行为细节；（3）该用例可能涉及的包含用例或扩展用例；（4）用例涉及抽象实体和页面的具体化及对应关系；（5）模块之间的数据依赖关系。（1）管理员点击确认导出成功后，在“生成导出文件”按钮旁显示“下载”按钮。（2