b.说明软件将干什么,如果需要的话,还要说明软件产品不干什么;
c.说明软件与其他系统的接口,本系统要完成什么,不完成什么,要实现的系统功能,需要其他系统提供什么,本系统需要为其他系统提供什么。
>
1.3术语和缩略语
术语、缩略语
解释
2需求概述
2.1用户描述
本产品涉及的用户为
2.1.1用户组织及职责
<客户概况描述:
重点对用户需求所涉及业务的相关组织机构、人员角色进行重点描述,主要包括如下几个方面的内容:
●职能处室划分及其职责范围
●上下级机构划分及其职责范围
●职能人员角色划分及其职责范围。
可先采用组织机构图的方式对整个组织机构、上下关系统进行表示,例如:
图22组织机构
然后分别对各机构、人员角色的职责范围进行说明。
举例:
如某区的综合事务管理平台的用户的组织结构示意图如下
然后分类说明相关人员的职责
>
2.1.2业务流程
<用直观的流程示意图,描述用户的工作流程,如城管类案卷处理>
如某区的工作流程如下:
(修改)
图21用户工作流程图
然后对个流程节点涉及工作项、参与者,按照流程顺序逐一说明。
>
2.1.3用户关注重点
<叙述在本项目中,用户特别重点关注的内容,比如某些用户关注效率,有些用户关注统计分析等。
>
2.2产品描述
<叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。
解释被开发软件与其他有关软件之间的关系。
如果本软件产品是一项独立的软件,而且全部内容自含,则说明这一点。
如果所定义的产品是一个更大的系统的一个组成部分,则应说明本产品与该系统中其他各组成部分之间的关系,为此可使用一张结构图来说明该系统的组成和本产品同其他各部分的联系和接口。
>
产品结构图举例:
对应用户的工作流程中的所有工作项,将产品分成不同的子系统(模块),各子系统(模块)又分为不同的子功能模块,使得产品结构图中的功能全部包含用户工作流程的各工作项。
图23产品结构图
2.3一般约束
<说明用户对本模块(子系统)运行时的各种要求。
如:
软件的功能要求、性能要求、硬件要求。
如用户没有要求,则给出用户“无要求”说明,如果依据常识我方可以提供性能、功能指标,需在本节给出明确说明。
●确定影响设计人员的各种限制问题:
●必须使用或者避免使用的特定技术、工具、编程语言和数据库
●用户所要求的规范和标准
●企业策略、政府法规、工业标准
●硬件限制,例如定时需求或者存储器限制
●数据转换格式标准
●特定功能的时间要求
●通常情况下的性能要求(特殊情况的性能要求,在功能描述中分别说明)
●第三方软件使用限制
●……
按照如下分类,可补充。
>;
2.3.1通信协议
采用SOAP协议;
Webservice协议;
2.3.2安全保密
必须满足**标准
2.3.3运行环境
<系统运行环境拓扑图:
示意图片
图23运行环境拓扑图
以下为运行环境分类说明,采用表格的方式。
表11运行环境总体说明
约束
操作系统
Windows、UNIX或LINUX,需版本、补丁说明
数据库系统
厂商、版本、额外安装包等
网络环境
协议,速率等
应用服务器
WebSphere、WebLogia、iAS、EAS等,需版本、补丁说明
第三方软件
本系统使用到的第三方软件说明,如:
MQ5.0
表12运行环境
数据库服务器
机器型号
CPU
内存
操作系统
应用软件(需版本、补丁说明)
可能有多行
Windows***/IBMAIX***
Oracle***/Sybase***
应用服务器
机器型号
CPU
内存
操作系统
应用软件(需版本、补丁说明)
可能有多行
Windows***/IBMAIX***
Tomcat***/Easerver***/Weblogic***
客户端
机器型号
CPU
内存
操作系统
应用软件(需版本、补丁说明)
系统使用到的第三方软件说明,如:
MQ5.0
说明
表13运行环境配置信息
数据库服务器
操作系统
应用软件
硬件配置及主要参数设置
□Windows***
□IBMAIX***
□Oracle***
□Sybase***
内存:
***
Cpu:
***
中间件服务器
□Windows***
□IBMAIX***
□Tomcat***
□Easerver***
□Weblogic***
□Websphere***
内存:
***
Cpu:
***
网络:
客户端
□Windows***
□IE***
内存:
***
Cpu:
***
分辨率:
第三方软件
本系统使用到的第三方软件说明,如:
MQ5.0
第三方软件接口
其他
1、上一版本信息:
(维护项目需要提供)
2、兼容性要求:
(建议提供细化的描述文档如上次法院6.6产品提交)
3、在这里进行生产环境的补充说明,譬如网络状况、布署方式(集群/非集群)及其他认为可能会影响布署系统性能的方面
本文应用于子模块时,可以不必具体说明,但是需要指明在其他哪篇汇总文档中可以获取此项目信息。
>
3功能需求
3.1功能划分
1、对模块需要实现的功能进行整体描述,为模块划分和功能描述提供依据。
2、对模块(子系统)功能进行分类,要求说明分类依据,以及特殊功能的分类方式。
达到:
可以按照功能分类进行功能模块划分的目的。
进行功能划分时,可以针对不同职能的用户的进行分类,也可以依照功能自然聚集情况进行分类。
表31功能划分
用户需求编号
一级模块名称及编号
二级模块名称及编号
说明
注:
编号规则:
用户需求编号:
项目简称+“-”+用户需求简称(英语或者拼音首字母,常用后者)
举例说明:
GDJT-RYGL(轨道交通系统登记用户需求)
一级模块编号:
项目的缩写—一级模块缩写
二级模块编号:
项目的缩写—一级模块缩写—两位数字序号(序号:
从01开始,加1递增,到99后,从A0递增至ZZ)
一个用户需求可能对应多个一级模块与二级模块
3.2用户角色和特征
岗位划分6
例:
表32用户分类
用户角色
特征说明
普通用户(操作人员)
说明向该类用户的提供的各种功能范围
高级用户(领导)
。
。
。
超级用户(管理员)
。
。
。
外部用户
。
。
。
必须填写此项说明,便于开发人员与读者对此系统或者模块有更全面的理解。
3.3功能描述
3.3.1一级模块名称1
3.3.1.1二级模块1(此处格式为:
产品需求编号-功能标题)
功能描述
<分项描述各个功能分类(模块、子系统)中的功能所实现的功能。
在描述操作功能时应给出操作行为和操作数据内容的说明。
>
采用用例图直观描述
3.3.1.2二级模块N
<本节内容参考分项需求1>
具体描述每个分项需求,辅助以图形界面。
3.3.2一级模块名称N
<本节内容参考模块名称1>
4非功能需求
4.1性能需求(用户需求编号-性能需求)
4.1.1数据量分析
<本节内容为性能测试提供素材。
●生产环境中实际存在的数据量;
●数据量增加频度:
(可按照xx条/月或xx条/年进行描述);
●并发量;
●用户数量范围>
4.1.2性能要求
<本节内容
1、某些(全部)业务操作响应时间期望值是(如50用户并发进行登陆操作时,响应时间小于2s);
2、服务器cpu、内存资源利用率要求(如一般要求小于80%);
3、其他要求:
例如是否要求单独部署在一台服务器上,如果不单独部署,其他已有应用有哪些,对本软件分别有何影响?
>
4.2运行需求
4.2.1硬件接口
<如果存在软件和硬件的接口交互,则必须在本节对每一接口的进行说明。
包括:
支持的硬件类型、软硬件之间交流的数据和控制信息的性质以及所使用的通信协议等。
如有相应的接口规范,则在本处给出相应的文档引用。
如接口较多,使用列表方式进行说明。
例如打印机型号等。
>
4.2.2软件接口
<如果本模块(子系统)需要与其他外部组件的进行交互,则在本节进行接口描述。
*注:
对于数据库等有规范的接口规格书的外部组件,说明使用ODBC,JDBC等即可。
对于其他比较特殊的(无规范)的外部组件,需要进行说明。
如没有与其他外部组件进行交互的要求,注明“无”。
Ø接口:
和本公司系统接口,和其他公司系统接口
Ø硬件相关接口:
视频、短信、软电话、车载、CA
ØGIS接口:
立得接口
Ø手机接口:
图盟(暂时不做)
Ø接口调试工具:
>
4.2.3故障处理
<描述系统的容错处理机制>
4.3易用性需求(可选)
<本节内容:
Ø界面总体风格一致,要求界面美观、一致、合理。
Ø操作简便,复杂操作具有向导提示。
提供在线帮助、助手(在办理时提供指导)
Ø用最少的步骤实现符合用户操作习惯,单个功能操作点击不超过多少次
Ø常用按钮和不常用按钮区分显示
Ø关联:
监督员、案卷链接操作、地图
Ø减少用户输入(默认填写意见)等>
4.4安全性需求(可选)
<安全性:
为了防止意外或人为的破坏,软件应具备的自身保护能力,例如数据传输过程中的网络安全、数据加密解密、数据存储的安全性等。
4.5可维护性需求(可选)
<本节内容:
Ø层次化、模块化、面向对象的系统设计结构。
Ø模块内高内聚、模块间低耦合的模块设计准则。
Ø简明的代码风格。
Ø科学合理的项目管理,完备的开发、设计文档,便于软件过程追踪。
Ø预留接口,便于适应性和完善性维护。
Ø功能全部必须可配置方式,必须在构建平台进行配置。
>
4.6可移植性需求(可选)
<本节内容
Ø系统基于ORACLE开发,支持ORACLE9i、10g、11g版本、支持RAC
Ø中间件:
Tomcat、weblogic、WebSphere、Apusic、TongWeb、集群
Ø客户端环境:
IE版本、操作系统(windows7xpvista20032008)
ØGIS:
ArcGIS、eGovaGIS、superMap(可浏览)
Ø操作系统:
windows
Ø负载均衡(硬件)
手机:
Ø操作系统:
windowsMobile、Android、IOS
Ø分辨率:
320*480等>
5待定问题列表
<此章节记录在需求有关的问题及解决情况,使用累加记录的方式,力求将问题和解决情况说明清楚,供项目负责人、各团队及所有访问本文档的人员提供过程性的记录回放,有利于大家对需求更深的了解。
表81待定问题列表
序号
问题
负责人
起止日期
状态
优先级
解决方案
6附录
6.1参考资料
资料名称[标识符]
出版单位
作者
日期
6.2需求确认
需求评审报告摘要
需求文档
输入名称,标识符,版本,作者,完成日期,...
需求评审报告
输入名称,标识符,评审日期,...
评审结论
[]工作成果合格,“无需修改”或者“需要轻微修改但不必再审核”。
[√]工作成果基本合格,需要做少量的修改,之后通过审核即可。
[]工作成果不合格,需要做出比较大的修改,之后必须重新对其评审。
评审意见
评审小组成员
输入评审小组成员