《软件需求规格说明书编写规范》
《软件需求规格说明书评审规范》
软件需求规格说明书编写规范
软件需求规格说明书评审规范
1编写目的
此文档为规范软件需求规格说明书文档编写而制定。
2使用范围
软件需求规格说明书是软件项目需求分析阶段的最终成果文件,也是软件项目最终验收的重要依据,因此该文件在软件项目中是非常重要的。软件需求规格说明书编写规范适用于所有软件项目的需求分析阶段。软件需求规格说明书需要提交客户双方签字确认后方可进入软件项目的下一个阶段。
3文档概述
文档包括软件需求规格说明书文档编写规范以及编写的注意点等内容。
4术语和缩略语
序号 | 缩写 | 说明 |
1 | 软件需求规格说明书 | 软件需求规格说明书是指在充分研究分析用户要求的基础上,由需求分析人员编写的说明书,是软件需求分析的最终结果。它详细定义了信息流和界面、功能需求、数据需求、设计要求和限制、测试准则和质量保证要求等。它的作用主要是:作为软件人员与用户之间事实上的技术合同说明;作为软件人员下一步进行设计和编码的基础;作为系统测试和项目验收的重要依据之一。 |
2 | 需求分析 | 确定所要设计的软件应该具有哪些功能和特性(即要让它做什么事)。 |
5编写规范
5.1总体描述
总体描述分为项目背景、项目目标、系统架构、总体流程、名称解释五个部分,各个部分的编写内容和要求如下。
5.1.1项目背景
描述客户基本情况、项目基本情况,可以在客户现场详细调研过程中了解、收集项目的背景,有利于项目组成员尽快的了解项目的基本情况。
5.1.2项目目标
客户需要通过该软件项目实现的总体目标描述,能够通过软件系统解决客户存在的问题,实现实施该项目的价值。
5.1.3系统架构
系统总体架构图、总体架构描述、系统实现技术、数据库技术、中间层系统、需求分析依据(现场详细调研报告、确认的业务流程图、现场收集的纸质或电子文件)等。
5.1.4总体流程
系统总体流程图,能够反映出系统全貌的功能、流程、输入、输出、操作岗位,需求分析人员要能够把握系统全局,并纵观全局。
5.1.5名称解释
对专业术语以及客户可能不理解的名词进行解释,目的是让客户能够理解。
5.2功能模块
5.2.1基础数据模块
5.2.1.1数据需求
主表:数据项1、数据项2……。
从表:数据项11、数据项22……。
数据项说明:
描述每一个数据项的数据类型、字段长度要求、维护方式(必输、非必输、数据选取(数据选取列表字段、排序方式、显示方式、查询条件)、数据字典(数据字典内容)、默认值)、字段前台显示说明、排序方式、排序字段说明、数值格式化说明、文本字数要求。
5.2.1.2使用说明
描述当前基础数据所使用的业务模块,该基础数据作为数据选择的前台列表字段、排序要求、选取条件、是否采用树型或者列表方式展示。
5.2.2业务功能模块
5.2.2.1业务流程
提供业务流程图,并标注当前功能模块在业务流程图中的位置,重点关注当前功能模块的前置流程和后置流程,了解当前功能模块数据的流转过程。
绘制业务流程图要求:
业务流程图通常包括:流程开始、业务功能、业务流向、输入、输出、操作岗位、注释、流程结束等图例,流程图强调图例使用准确,同时整个流程图要紧凑、美观。
5.2.2.2业务场景
描述当前功能模块的操作业务场景,详细描述在客户真实业务环境中的应用过程,描述包括当前功能模块的功能作用、操作过程、数据流向、输入输出表单、操作结果等,如同写小说一样将做一件事情的来龙去脉、先后顺序描述出来,描述清楚,没有歧义,对不了解业务的人员通过业务场景的描述,也能够了解该业务。
5.2.2.3数据需求
主表:数据项1、数据项2……。
从表:数据项11、数据项22……。
数据项说明:
描述每一个数据项的数据类型、字段长度要求、维护方式(必输、非必输、数据选取(数据选取列表字段、排序方式、显示方式、查询条件)、数据字典(数据字典内容)、默认值)、字段前台显示说明、排序方式、排序字段说明、数值格式化说明、文本字数要求。
5.2.2.4界面需求
描述列表页、编辑页的页面需求,不论是A类项目,还是B类项目,只要是非常规功能模块,非格式化功能模块需要提供静态页面(RP图),并要求分开描述列表页显示字段、排序方式,编辑页显示字段、排序要求。
字段在编辑页面中的录入框长度,多次重复在其他模块使用的一组列表字段的宽度说明(在开发规范中详细说明)。
5.2.2.5功能需求
※ 列表页功能
ü 需要提供的功能按钮以及每一个功能按钮的详细操作说明,包括单据状态、数值回填(直接更新、累计更新)、数据更新、单据流转、快捷查询条件说明、详细查询条件说明、反向操作及数据还原、人机交互语句、业务验证、工作列表提醒。
※ 编辑页功能
ü 需要提供编辑页面的功能按钮以及每一个功能按钮的详细操作说明,包括输入、输出要求、单据状态、数值回填(直接更新、累计更新)、数据更新、单据流转、人机交互语句、业务验证、工作列表提醒。
5.2.2.6权限需求
当前功能模块所属客户操作部门以及操作岗位(角色),数据查询、数据权限、权限分管需求等,同时还包括在角色中的权限级别设置(人员分管、组织分管)。
5.2.2.7其他需求
其他需求包括打印需求、导出需求、附件上传、附件浏览、性能需求(大数据量、大并发用户等)以及客户其他特定的需求等。
5.2.3查询功能模块
5.2.3.1查询条件
需要提供查询条件、条件排列顺序、查询条件的维护方式。
5.2.3.2查询结果
查询结果列表数据项,按照顺序整理。
5.2.3.3功能说明
功能说明包括查询数据来源(表)、数据项列表要求、排序要求(客户关心的重要字段的排序)、关联显示要求、性能需求、是否提供导出功能(导出格式)、是否提供打印功能(打印格式)、权限需求。
5.2.4统计报表模块
5.2.4.1报表条件
需要提供报表条件、条件排列顺序、报表条件的维护方式。
5.2.4.2报表列表
报表统计结果列表数据项,按照顺序整理。
5.2.4.3报表格式
提供报表格式,使用EXCEL表格画出报表样式,然后截图放在报表格式中。
5.2.4.4统计说明
统计说明中包括报表统计数据来源(表)、统计要求、数据项列表要求、排序要求、分类小计合计、性能需求、是否提供导出功能(导出格式)、是否提供打印功能(打印格式)、权限需求。
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。