开发文档需求规格说明书格式.docx

开发文档需求规格说明书格式.docx

《开发文档需求规格说明书格式.docx》由会员分享，可在线阅读，更多相关《开发文档需求规格说明书格式.docx（19页珍藏版）》请在冰豆网上搜索。

开发文档需求规格说明书格式

江东区经济社会综合统计信息平台

需

求

规

格

说

明

书

宁波优创信息技术有限公司

二零一零年八月

项目编号

分发号

版本号

1.00

受控状态

受控

XXXXXXXXX系统

需求规格说明书

项目承担部门：

撰写人（签名）：

完成日期：

需求提供人（签名）：

提供日期：

评审人（签名）：

评审日期：

批准人（签名）：

批准日期：

文档控制页

编号

章节名称

修订内容简述

修订日期

修订前版本

修订后版本

修订人

批准人

1

全文

创建

2009-10-27

1.0

刘丽鹃

江文

2

全文

修订

2010-02-20

1.3

肖煜林

江文

3

全文

修订

2010-02-24

1.7

刘丽鹃

江文

4

全文

修订

2010-07-25

2.0

肖煜林

江文

1.引言

编写目的

说明编写这份软件需求说明书的目的，指出预期的读者范围。

如（定义软件总体要求，作为用户、软件开发人员以及其他干系人之间沟通的基础；描述功能要求、性能要求、用户和系统的接口要求、数据库等内容，作为软件开发人员进行软件结构设计、编码的基础；作为软件总体测试的依据。

）等

编写需求说明书的目的是作为软件开发方与客户方的沟通软件需求的一个依据，将具体的需求文字化可以消除双方在语言表述、理解方面的误差。

需求说明书除具体的功能需求外，还包括项目开发时通常要确定的事项。

需求说明书要得到软件开发方、客户方的签字确认。

需求说明书是项目设计人员设计项目实现的基础。

项目背景

列出本文件中用到的专门术语的定义和缩写词的原词组。

如下：

甲方：

xxx有限公司。

乙方：

xxx有限公司。

招标书：

由甲方提供的《招投标技术规范书》。

投标书：

由乙方提供的《技术方案书》。

参考资料

列出要用到的参考资料，如：

1）本项目的经核准的计划任务书或合同、上级机关的批文；

2）属于本项目的其他已发表的文件；

3）本文件中各处引用的文件、资料，包括所要用到的软件开发标准。

列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

《招标书》

《投标书》

《项目管理制度》

xxxx质量管理体系文件

ISO9001：

2000

《软件工程国家标准汇编》

2.总体概述

软件标识

项目名称：

尚学堂WebOA管理系统；

项目编号：

U0055

产品范围：

按照《招标书》中5.2的规定执行。

产品名称：

产品简称：

版本号：

1.00

产品描述

叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。

解释被开发软件与其他有关软件之间的关系。

如果本软件产品是一项独立的软件，而且全部内容自含，则说明这一点。

如果所定义的产品是一个更大的系统的一个组成部分，则应说明本产品与该系统中其他各组成部分之间的关系，为此可使用一张方框图来说。

用户特点

列出本软件的最终用户的特点，充分说明操作人员、维护人员的教育水平和技术专长，以及本软件的预期使用频度。

这些是软件设计工作的重要约束。

确认用户人群的操作偏好，如以前、最近是否有使用顺手的软件系统，有没有特定的操作偏好。

开发工具

应用程序语言：

JAVA版本号1.6

应用程序服务器：

tomcat版本号6.0

操作系统：

WindowsXP

模型工具：

Powerdesign

编码工具：

Eclipse、Myeclipse

数据库名称：

MYSQL版本号5.0数据库要考虑是开源免费的，还是收费的，收费的金额

3.功能列表

按照层次结构列出项目的功能清单。

序号

功能名称

功能需求标识

优先级

简要描述

个人办公

我的办公桌

高

打开个人办公桌，在个人办公桌上，是到达各种管理功能的快捷链接

我的便签

低

随手记录的信息

我的任务

低

任务管理

通信录

低

个人通信录

公文管理

公文维护

高

各种类型的公文管理、审批公文等

归档处理

高

对已完成流转的公文进行归档

4.功能描述

对于每一个功能、一类功能，具体描述其基本信息、引言、工作流需求、可选异常事件流、补充规约。

1．基本信息

基本信息包括模块名称、主要角色、前置条件、后置条件、用户操作。

2．引言

描述功能的意图、目标，采用的方法和技术，必要时说明功能由来、背景。

3．工作流（输入、加工、输出）

用顺序表格的方式详细描述功能的工作流，类似的工作流在不影响用户理解的情况下可以合并描述。

工作流的模式为“用户操作>>系统处理>>系统输出”，分别对应输入、加工、输出。

一连串不间断的操作为一个工作流。

工作流之间使用空白行分隔。

输入：

详细描述用户操作时的输入数据、输入限制，操作方式（用户的页面事件，如点击链接、提交表单等）；客户显示要求时，说明操作细节的需求。

如下拉菜单联动，过滤等；必要时说明实现、引用的接口及其控制参数。

加工：

描述把用户输入转换成相应输出的任何方法（脚本操作、数据库操作、逻辑处理等）。

输出：

详细描述该功能输出数据，如：

文件输出、数据列表、页面刷新等。

4．可选、异常事件流

参照工作流

5．补充规约

描述其它条目中不便说明的补充事项。

如特定的代码的数据规则等。

业务登记

R001

业务登记

主要角色

经营部业务室

前置条件

用户已经登录

后置条件

用户将业务记录到系统中

用户操作

增加、编辑、删除、提交

引言：

功能意图、目标

相关方法、技术

典型事件流

步骤号

用户

系统

业务信息的增加、修改流程

界面初始时显示系统已有业务登记列表

选择“新增”、“修改”功能

载入可填写表单

输入：

法人代表、客户名称、联系电话、联系人、联系地址、税务登记证，开户银行帐号、登记人、登记日期、项目编号、项目名称、工程类别，项目内容，设计图完工日期，工程竣工日期，附件上传

表单校验规则：

除附件外都是必填项

选择“增加”、“保存”按扭

表单校验，校验失败时提示，校验成功时流程继续

服务器成功保存数据

系统显示已有业务登记列表

提示下一阶段的流向选择工程部现场查勘和物资部设备清单反馈

服务器保存数据失败

系统跳转到异常提示页面

业务信息的删除流程

选择“删除”功能

服务器删除对应数据

系统显示已有业务登记列表

提示数据删除成功

可选、异常事件流

补充规约（技术规则或数据细节等）

项目编号由系统自动产生，规则“工程属性+年份+区域+流水号”，工程属性为管理办法中的四个工程类型，本需求中只涉及客户业扩工程（专变），编号为ZB，年份用四位表示，如2009；区域用两位数表示：

01江东，02江北，03海曙；流水号用三位数表示：

001；例“01-2009-01-001”表示江东局2009年专变工程的第一个项目；

附件上传部分参加用例29

工程类别分为以下几种：

用户专变：

新装（高供高计）、新装（高供低计）、临时变、增（减）容

事故处理：

网内工程、用户工程

网内工程：

基建，技改，大修

小区变工程

用户迁移或改道工程（黄色部分不在本期项目内）

回退信息的显示：

回退人，回退时间，回退内容，回退阶段；按时间倒序显示，即最近的显示最前面

功能一

R002

业务登记

主要角色

经营部业务室

前置条件

用户已经登录

后置条件

用户将业务记录到系统中

用户操作

增加、编辑、删除、提交

引言：

功能意图、目标

相关方法、技术

典型事件流

步骤号

用户

系统

业务信息的增加、修改流程

界面初始时显示系统已有业务登记列表

选择“新增”、“修改”功能

载入可填写表单

输入：

法人代表、客户名称、联系电话、联系人、联系地址、税务登记证，开户银行帐号、登记人、登记日期、项目编号、项目名称、工程类别，项目内容，设计图完工日期，工程竣工日期，附件上传

表单校验规则：

除附件外都是必填项

选择“增加”、“保存”按扭

表单校验，校验失败时提示，校验成功时流程继续

服务器成功保存数据

系统显示已有业务登记列表

提示下一阶段的流向选择工程部现场查勘和物资部设备清单反馈

服务器保存数据失败

系统跳转到异常提示页面

业务信息的删除流程

选择“删除”功能

服务器删除对应数据

系统显示已有业务登记列表

提示数据删除成功

可选、异常事件流

补充规约（技术规则或数据细节等）

项目编号由系统自动产生，规则“工程属性+年份+区域+流水号”，工程属性为管理办法中的四个工程类型，本需求中只涉及客户业扩工程（专变），编号为ZB，年份用四位表示，如2009；区域用两位数表示：

01江东，02江北，03海曙；流水号用三位数表示：

001；例“01-2009-01-001”表示江东局2009年专变工程的第一个项目；

附件上传部分参加用例29

工程类别分为以下几种：

用户专变：

新装（高供高计）、新装（高供低计）、临时变、增（减）容

事故处理：

网内工程、用户工程

网内工程：

基建，技改，大修

小区变工程

用户迁移或改道工程（黄色部分不在本期项目内）

回退信息的显示：

回退人，回退时间，回退内容，回退阶段；按时间倒序显示，即最近的显示最前面

功能二

R001

业务登记

主要角色

经营部业务室

前置条件

用户已经登录

后置条件

用户将业务记录到系统中

用户操作

增加、编辑、删除、提交

引言：

功能意图、目标

相关方法、技术

典型事件流

步骤号

用户

系统

业务信息的增加、修改流程

界面初始时显示系统已有业务登记列表

选择“新增”、“修改”功能

载入可填写表单

输入：

法人代表、客户名称、联系电话、联系人、联系地址、税务登记证，开户银行帐号、登记人、登记日期、项目编号、项目名称、工程类别，项目内容，设计图完工日期，工程竣工日期，附件上传

表单校验规则：

除附件外都是必填项

选择“增加”、“保存”按扭

表单校验，校验失败时提示，校验成功时流程继续

服务器成功保存数据

系统显示已有业务登记列表

提示下一阶段的流向选择工程部现场查勘和物资部设备清单反馈

服务器保存数据失败

系统跳转到异常提示页面

业务信息的删除流程

选择“删除”功能

服务器删除对应数据

系统显示已有业务登记列表

提示数据删除成功

可选、异常事件流

补充规约（技术规则或数据细节等）

项目编号由系统自动产生，规则“工程属性+年份+区域+流水号”，工程属性为管理办法中的四个工程类型，本需求中只涉及客户业扩工程（专变），编号为ZB，年份用四位表示，如2009；区域用两位数表示：

01江东，02江北，03海曙；流水号用三位数表示：

001；例“01-2009-01-001”表示江东局2009年专变工程的第一个项目；

附件上传部分参加用例29

工程类别分为以下几种：

用户专变：

新装（高供高计）、新装（高供低计）、临时变、增（减）容

事故处理：

网内工程、用户工程

网内工程：

基建，技改，大修

小区变工程

用户迁移或改道工程（黄色部分不在本期项目内）

回退信息的显示：

回退人，回退时间，回退内容，回退阶段；按时间倒序显示，即最近的显示最前面

5.角色设置

列出角色的分类名称，简述各角色的权限、职责范围。

6.初始化数据

列出系统初始化时需要录入哪些数据。

如用户信息初始化等。

7.一般约束

本条各小节对设计系统时限制开发者选择的其它项作一般性描述。

而这些项将限定开发者在设计系统时的任选项。

硬件约束

本条包括各种软件运行的硬件约束，如：

1）硬件的详细配置；

2）硬件的负载，如只运行本系统，还是和其它系统共用。

安全性

说明如何保护软件，以防止偶然或恶意的访问、使用、修改或泄密。

这个领域的具体需求必须包括：

1）利用可靠的密码技术；

2）防止SQL注入；

3）区分用户权限；

4）选择性的是使用CA证书；

可用性

可以指定一些因素，如检查点、恢复和再启动等，以保证整个系统有一个确定的可用性级别。

即当系统出现异常时执行什么样的操作能保证系统再次正常运行，以及这种操作是否有何种负面影响。

性能要求

本条说明软件数据处理能力和时间特性的需求。

数据处理能力可能包括：

支持的终端数、支持并行操作的用户数、处理的文件和记录数、表和文件的大小。

时间特性可能包括：

响应时间、更新处理时间、数据的转换和传送时间、运行时间等。

数据库要求

本条说明对软件应用的数据库的需求，如：

数据库名称、版本、数据项、记录、文件标识、静态和动态的组织、存取能力等。

存储特性：

数据库的编码方式，备份方式，可能的最大字节数。

管理维护方针

描述软件启动、关闭的管理方式。

描述软件内容日常维护、管理的方式。

并行操作

本条描述是否存在两个用户同一时刻操作同一条数据库记录的可能性，以及在这种情况是否要实现数据的保护、同步。

可移植性

说明软件对软、硬件环境的兼容，它从一个环境移植到另一个环境的约束等。

其它标准的约束

本条描述由现有的标准或规则派生的要求，如：

1）报表格式

2）数据命名

3）会计准则

4）审计追踪等等。

8.外部接口要求

用户接口

本条说明为方便用户使用而提出的软件与用户界面的需求。

如：

1）屏幕格式

2）浏览器支持类型

3）报表格式

4）菜单格式

5）功能键的使用，如回车等快捷键。

6）表单的操作要求，如回车提交，TAB切换等。

硬件接口

本条说明软件与硬件间各接口，可使用接口框图进行说明。

说明内容包括：

1）接口标识

2）功能描述

3）信号方向、格式、传输协议

4）优先级

5）响应时间

6）异常处理

对每一硬件，需提供名称、缩写、型号、数量，并说明其功能。

软件接口

本条指定需使用的其他软件产品（如：

数据管理系统、操作系统、数学软件包），以及同其他应用系统之间的接口。

如果已有完整的接口文件，需在本条指明。

说明内容包括：

1）接口标识

2）功能描述

3）数据流程和控制流程的方向

4）数据格式、容量

5）接口类型（如手动或自动）

6）接口数据中断的优先级别

7）中断响应时间

8）异常处理等

对每一个所需的软件产品，需提供名称、缩写、规格说明、版本号、来源等内容。

通信接口

本条指定各种通信接口，如局域网的协议等。

假设和依据

本条列出影响需求说明中陈述的需求的每一个因素。

这些因素不是软件的设计约束，但是它们的改变可能影响到需求说明中的需求。

例如：

假定一个特定的操作系统是在被软件产品指定的硬件上使用的，然而，事实上这个操作系统是不可能使用的，于是，需求说明就要进行相应的改变。

《软件需求说明书》确认协议

甲方：

XX

乙方：

XX

在甲方的大力配合与支持下，乙方制作了该《软件需求说明书》；甲方对该《软件需求说明书》经过详细审核，已确认该《软件需求说明书》中的各项内容翔实全面，该《软件需求说明书》中的内容已完全包括了《项目开发委托合同》中的《用户需求说明书》部分中关于软件产品的需求。

经过甲乙双方友好协商，达成如下协议：

1．该《软件需求说明书》是《项目开发委托合同》的补充文件，与《项目开发委托合同》具有同等的法律效力；

2．该《软件需求说明书》是《项目开发委托合同》中_____条__________款软件产品最终验收的唯一标准；

3．甲方在《项目开发委托合同》中_____条__________款软件产品最终验收前可提出对该《软件需求说明书》中的内容进行变更（包括增加、修改、删除），双方应就此签署《软件产品需求更改备忘录》或补充协议；

4．甲方同意乙方根据该《软件需求说明书》进行《项目开发委托合同》中_____条__________款软件产品的开发；

5．本协议一式二份，甲乙双方各执一份；

6．本协议自甲乙双方签字之日起生效。

甲方委托人（签字）：

乙方委托人（签字）：

甲方单位（盖章）：

乙方单位（盖章）：

年月日年月日