需求规格说明书_模板.doc

XXX系统需求规格说明书需求规格说明书更改记录日期修改章节修改类型修改描述修改人版本2011-09-23全部A创建文档董善飞1.0*修改类型分为 A - ADDED M - MODIFIED D DELETED 机密第 1 页 共 14 页2020/1/17XXX系统需求规格说明书 目 录一、文档约定31文档项目编号32业务流程图33用例图34实体关系图45属性说明46状态流转图47数据流图58需求优先级说明59功能编码610术语和缩略语6二、需求概述71系统目标72用户类和特征73业务分析74系统架构75运行环境76安装和部署77限制和约束8三、业务实体描述91编码规则92子系统名称93数据字典9四、功能性需求101XX 子系统101.1XX模块10五、非功能性需求131易用性132稳定性133性能134安全性135可扩展性136可维护性137用户文档138质量要求13六、附录14一、 文档约定为使预期读者能够顺利、准确理解本文档内容，在此对文档中的“特殊语言”加以约定，即本文档中使用的格式、符号等内容在此做统一标准，以使本文读者能够在共同语言的基础上理解本文档内容。1 文档项目编号此需求规格说明文档以“一、1、1.1、1.1.1 ”项目编号形式编排，依次表示“大标题”、“次标题”、“子条目”优先级。2 业务流程图本文档中的业务流程图中，所应用图形含义约定如下：项目说明图例过程业务处理的操作预定义过程包含细化过程的业务操作判断对过程执行条件的判断操作开始某一个业务过程起始的标识结束某一个业务过程完成的标识标注对某项目进一步解释说明的标识3 用例图本文档中的用例（UC）图中，所应用图形含义约定如下：项目说明图例参与者在图形下方标明参与者名称，可以是系统内的用户类，也可以是外部系统用例在图形下方标明动作关联用来连接参与者与用例包含用来连接用例，箭头指向的是被包含的用例扩展用来连接用例，箭头由扩展用例指向基用例泛化用来连接用例与用例，参与者与参与者，由子指向父4 实体关系图本文档中的实体关系（ER）图中，所应用图形含义约定如下：项目说明图例实体矩形框内写明业务实体名称属性椭圆框内写明属性名称，多值属性用双线与实体连接，主属性名称下加下划线联系菱形框内写明联系名，并用无向边分别与有关实体连接起来，同时在无向边旁标上联系的类型，联系类型包括1：1（一对一）、1：N（一对多）、N：M（多对多）5 属性说明本文档中业务实体的属性清单中，各列表项的含义约定如下： 名称：属性的中文显示名称； 输入方式：A表示手工输入、B表示下拉单选、Bn表示列表多选、C表示单项选择其他实体、Cn表示多项选择其他实体、D表示系统自动生成，允许属性有多种输入方式； 是否必填：Y表示必填、N表示非必填，默认非必填； 备注：其它需要说明事项，例如：属性的长度限制、特殊格式要求、输入方式的特殊要求（如与其它属性的联动等）、校验提示说明、默认值；需要特别声明的是，这里的业务属性说明只是从需求的角度阐述完成业务操作的必要前提，绝不代表数据库设计，离数据库设计还有很大的差异，但会是将来数据库设计的很好依据。6 状态流转图本文档中的状态流转(STD)图中，所应用图形含义约定如下：项目说明图例初始状态一张图中只能有一个初始状态最终状态一张图中可以有一个或多个最终状态状态圆角矩形框内标明状态名称迁移在有向线上方的“事件”中标明导致状态发生迁移的事件，“条件”标明状态的分支，“动作”表明在事件中需执行的动作7 数据流图本文档中的数据流(DFD)图中，所应用图形含义约定如下：项目说明图例外部实体方框内标明外部实体名称，外部实体可以是用户类，也可以是外部系统处理圆内标明数据流的逻辑处理过程数据存储在双线间标明数据存放的地方数据流在线段上方标明传递的数据内容8 需求优先级说明优先级别重要程度说明R最优先必须实现。本文中未做特别表明的需求，优先级均默认为优先级1。P优先争取实现，如困难，可以变通方式实现M中等争取实现，如困难，可以变通方式实现；如实在困难，受各种客观软硬件条件影响，可以考虑到再升级时实现D可以等待争取实现，如困难，可以变通方式实现，且不对该功能实现做时间上的要求；如实在困难，可考虑再升级时实现N不太必要再升级时实现9 功能编码子系统简称-编号-需求优先级-功能名称 子系统简称：使用三到四个字母缩写标明功能所属的子系统 编号：每个子系统从1开始编号 需求优先级：使用R、P、M、D、N，具体含义参见“需求优先级说明” 功能名称：使用能够直观表达含义的单个完整英文单词或简单的英文词组10 术语和缩略语【】：二、 需求概述1 系统目标使用顶层DFD(数据流)图和简要文字描述系统范围及边界2 用户类和特征在下表中使用文字描述,也可以使用若干张USECASE图表示系统最终用户的类别及主要的业务应用用户类主要业务应用3 业务分析使用整体职能流程图描述系统整体业务 4 系统架构用需求分析人员自己熟悉的架构图结合文字描述系统的逻辑层次及各层功能构成，小规模项目可省略 5 运行环境使用清单描述系统的服务端和客户端的软件平台的一般要求，也可以使用UML中的构件图来说明6 安装和部署使用文字描述系统运行必须的软件平台安装步骤，如果有历史系统，需要描述切换策略和历史数据迁移的范围，如果有基础数据需要初始化，需要在此处描述初始化的具体内容及可能采用的方式,也可以使用部署图表示系统的软硬件整体结构7 限制和约束记录系统全局性的要求，例如备注字段的长度、日期的显示格式、金额字段的显示样式，,如果在功能性需求中无特殊说明，则业务实体描述中的实体属性清单中的属性出现的顺序，即为呈现给最终用户的顺序.三、 业务实体描述此处使用全局实体关系图描述系统主要业务实体之间的逻辑关系1 编码规则主要业务实体的业务唯一性编号生成规则说明,如果没有可以省略本节2 子系统名称使用ER图描述子系统内的各业务实体静态关系，使用下表分别列出模块内各业务实体的属性清单业务实体名名称输入方式必填项备注3 数据字典名称可选项备注四、 功能性需求使用树形的功能体系图描述功能分布，基本上这就是系统的菜单导航和功能权限树, 需定义各子系统简称,，以便功能需求编码,建议使用功能流程图补充说明系统关键路径，以便项目经理能够根据关键路径合理分配资源1 XX 子系统使用细化的职能流程图说明子系统支持的业务应用, 使用STD(状态流转)图描述子系统内关键业务单据的状态流转1.1 XX模块使用下表作为功能需求说明的具体模板，事务类业务操作和统计类操作的使用不同的模板,如果业务需求文档已经编号，则两个模板中都要增加属性：【业务需求编号】，考虑是否在模板中增加【需求确认人】1.1.1 CRUD类功能需求模板【功能编码】【功能描述】描述功能应用的业务场景【用户角色】与“需求概述”中的用户类对应【输入描述】描述输入数据流，细化到所有的属性的布局，输入的校验,如果无特殊要求，可直接标明来源于哪个业务实体即可【处理流程】使用DFD（数据流）图说明处理过程，必要时可使用判定树/表等方式补充说明【输出描述】描述输出数据流及可能存在的后续处理操作【约束条件】不同于需求概述中“限制和约束”的特殊前置条件或后续结果1.1.2 LIST类功能需求模板【功能编码】【功能描述】描述功能应用的业务场景【用户角色】与“需求概述”中的用户类对应【输入描述】条件名称是否必填输入方式选择方式可否多选是否默认全部是否模糊默任值对应输出列备注说明：是否必填，可否多选，是否默认全部，是否模糊：是、否默认值：无默认值的留空输入方式：手工、选择、oth选择方式：下拉、日历、树状注意应在上表下方说明条件之间的与或关系 【输出结果样式】结果表头（即是否回显输入）结果标题列结果内容列说明：注意小计、总计行如果有需求，必须在样式里画出来，包括输出内容在列中的对齐方式输出结果的使用方式是直接在页面内显示，还是可下载结果、下载结果中是否带样式，是否翻页，是否显示总记录数都要在这里说明，普遍性约束可在“需求概述”的限制和约束中说明【结果排序说明】标题列名称顺序排序方式说明：顺序从开始编号排序方式：升序、降序【内容列详细说明】标题列名称数据来源计算公式样式说明小数位数值精度千位分隔符单位备注说明：样式说明：文本、整数、小数、百分数、日期(精确到日、精确到秒毫秒)小数位：如果输出内容主体是小数，小数点后保留几位，输入要保留的位数数值精度：未保留的小数部分是四舍五入、直接取整还是其它的处理方式千位分隔符：输出内容主体如果是数字，是否使用千位分隔符，填是或否单位：输出内容对应的单位，直接手工填写【约束条件】输入与输出是否受权限控制，具体的控制要求是什么【验证规则】与哪个参照系统对比，验证使用的条件和结果说明五、 非功能性需求1 易用性文字描述整体界面风格及操作模式，必要时使用图片补充说明,下述内容可作为获取易用性需求的参考1 CRUD中的D类功能中是否要进行确认2 CRUD中的CU类功能是执行前集中校验还是即时校验输入属性值的合法性32 稳定性平均无故障运行时间等指标要求3 性能页面平均/最大响应时间等，注意需要描述应用环境（服务器软硬件