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

江东区经济社会综合统计信息平台江东区经济社会综合统计信息平台 需需 求求 规规 格格 说说 明明 书书 宁波优创信息技术有限公司宁波优创信息技术有限公司 二零一零年八月二零一零年八月 第 2 页 共 2 页2 XXXXXXXXX 系统系统 项目编号项目编号 分发号分发号 版本号版本号1 00 受控状态受控状态受控受控 需求规格说明书需求规格说明书 项目承担部门 撰写人 签名 完 成 日 期 需求提供人 签名 提 供 日 期 评审人 签名 评 审 日 期 批准人 签名 批 准 日 期 江东区经济社会综合统计信息平台需求规格说明书 第 1 页 共 2 页 文档控制页文档控制页 编号章节名 称 修订内容 简述 修订日期修订前 版本 修订后版 本 修订人批准人 1 全文创建 2009 10 271 0 刘丽鹃江文 2 全文修订 2010 02 201 3 肖煜林江文 3 全文修订 2010 02 241 7 刘丽鹃江文 4 全文修订 2010 07 252 0 肖煜林江文 江东区经济社会综合统计信息平台需求规格说明书 第 2 页 共 2 页2 目目 录录 1 引言引言 1 1 1编写目的 1 1 2项目背景 1 1 3参考资料 1 2 总体概述总体概述 2 2 1软件标识 2 2 2产品描述 2 2 3用户特点 2 2 4开发工具 2 3 功能列表功能列表 3 4 功能描述功能描述 3 4 1业务登记 4 4 2功能一 5 4 3功能二 7 5 角色设置角色设置 8 6 初始化数据初始化数据 8 7 一般约束一般约束 8 7 1硬件约束 8 7 2安全性 9 7 3可用性 9 7 4性能要求 9 7 5数据库要求 9 7 6管理维护方针 9 7 7并行操作 9 7 8可移植性 10 7 9其它标准的约束 10 8 外部接口要求外部接口要求 10 8 1用户接口 10 8 2硬件接口 10 8 3软件接口 11 8 4通信接口 11 8 5假设和依据 11 江东区经济社会综合统计信息平台需求规格说明书 第 1 页 共 13 页 1 引言引言 1 1 编写目的编写目的 说明编写这份软件需求说明书的目的 指出预期的读者范围 如 定义软 件总体要求 作为用户 软件开发人员以及其他干系人之间沟通的基础 描述 功能要求 性能要求 用户和系统的接口要求 数据库等内容 作为软件开发 人员进行软件结构设计 编码的基础 作为软件总体测试的依据 等 编写需求说明书的目的是作为软件开发方与客户方的沟通软件需求的一个 依据 将具体的需求文字化可以消除双方在语言表述 理解方面的误差 需求 说明书除具体的功能需求外 还包括项目开发时通常要确定的事项 需求说明书要得到软件开发方 客户方的签字确认 需求说明书是项目设计人员设计项目实现的基础 1 2 项目背景项目背景 列出本文件中用到的专门术语的定义和缩写词的原词组 如下 甲方 xxx 有限公司 乙方 xxx 有限公司 招标书 由甲方提供的 招投标技术规范书 投标书 由乙方提供的 技术方案书 1 3 参考资料参考资料 列出要用到的参考资料 如 1 本项目的经核准的计划任务书或合同 上级机关的批文 2 属于本项目的其他已发表的文件 3 本文件中各处引用的文件 资料 包括所要用到的软件开发标准 列出这些文件的标题 文件编号 发表日期和出版单位 说明能 够得到这些文件资料的来源 招标书 投标书 项目管理制度 xxxx 质量管理体系文件 江东区经济社会综合统计信息平台需求规格说明书 第 2 页 共 13 页2 ISO 9001 2000 软件工程国家标准汇编 2 总体概述总体概述 2 1 软件标识软件标识 项目名称 尚学堂 Web OA 管理系统 项目编号 U0055 产品范围 按照 招标书 中 5 2 的规定执行 产品名称 产品简称 版本号 1 00 2 2 产品描述产品描述 叙述该项软件开发的意图 应用目标 作用范围以及其他应向读者说明的 有关该软件开发的背景材料 解释被开发软件与其他有关软件之间的关系 如果本软件产品是一项独立 的软件 而且全部内容自含 则说明这一点 如果所定义的产品是一个更大的 系统的一个组成部分 则应说明本产品与该系统中其他各组成部分之间的关系 为此可使用一张方框图来说 2 3 用户特点用户特点 列出本软件的最终用户的特点 充分说明操作人员 维护人员的教育水平 和技术专长 以及本软件的预期使用频度 这些是软件设计工作的重要约束 确认用户人群的操作偏好 如以前 最近是否有使用顺手的软件系统 有 没有特定的操作偏好 2 4 开发工具开发工具 应用程序语言 JAVA 版本号 1 6 应用程序服务器 tomcat 版本号 6 0 操作系统 Windows XP 模型工具 Powerdesign 编码工具 Eclipse Myeclipse 江东区经济社会综合统计信息平台需求规格说明书 第 3 页 共 13 页 数据库名称 MYSQL 版本号 5 0 数据库要考虑是开源免费的 还是收 费的 收费的金额 3 功能功能列表列表 按照层次结构列出项目的功能清单 序号序号功能名称功能名称功能需求标识功能需求标识优先级优先级简要描述简要描述 个人办公个人办公 我的办公桌 高打开个人办公桌 在个人办 公桌上 是到达各种管理功 能的快捷链接 我的便签低随手记录的信息 我的任务低任务管理 通信录低个人通信录 公文管理公文管理 公文维护 高各种类型的公文管理 审批 公文等 归档处理 高对已完成流转的公文进行归 档 4 功能功能描述描述 对于每一个功能 一类功能 具体描述其基本信息 引言 工作流需求 可选异常事件流 补充规约 1 基本信息 基本信息包括模块名称 主要角色 前置条件 后置条件 用户操作 2 引言 描述功能的意图 目标 采用的方法和技术 必要时说明功能由来 背景 3 工作流 输入 加工 输出 用顺序表格的方式详细描述功能的工作流 类似的工作流在不影响用户理 解的情况下可以合并描述 江东区经济社会综合统计信息平台需求规格说明书 第 4 页 共 13 页4 工作流的模式为 用户操作 系统处理 系统输出 分别对应输入 加 工 输出 一连串不间断的操作为一个工作流 工作流之间使用空白行分隔 输入 详细描述用户操作时的输入数据 输入限制 操作方式 用户的页 面事件 如点击链接 提交表单等 客户显示要求时 说明操作细节的需求 如下拉菜单联动 过滤等 必要时说明实现 引用的接口及其控制参数 加工 描述把用户输入转换成相应输出的任何方法 脚本操作 数据库操 作 逻辑处理等 输出 详细描述该功能输出数据 如 文件输出 数据列表 页面刷新等 4 可选 异常事件流 参照工作流 5 补充规约 描述其它条目中不便说明的补充事项 如特定的代码的数据规则等 4 1 业务登记业务登记 R001业务登记 主要角色经营部业务室 前置条件用户已经登录 后置条件用户将业务记录到系统中 用户操作增加 编辑 删除 提交 引言 功能意图 目 标 相关方法 技 术 典型事件流典型事件流 步骤号步骤号用户用户系统系统 业务信息的增加 修改流程 界面初始时显示系统已有业务登记列 表 选择 新增 修改 功能 载入可填写表单 输入 法人代表 客户名称 联系电 话 联系人 联系地址 税务登记证 开户银行帐号 登记人 登记日期 项目编号 项目名称 工程类别 项 表单校验规则 除附件外都是必填项 江东区经济社会综合统计信息平台需求规格说明书 第 5 页 共 13 页 目内容 设计图完工日期 工程竣工 日期 附件上传 选择 增加 保存 按扭 表单校验 校验失败时提示 校验成 功时流程继续 服务器成功保存数据 系统显示已有业务登记列表 提示下一阶段的流向选择工程部现场 查勘和物资部设备清单反馈 服务器保存数据失败 系统跳转到异常提示页面 业务信息的删除流程 选择 删除 功能 服务器删除对应数据 系统显示已有业务登记列表 提示数据删除成功 可选 异常事件流可选 异常事件流 补充规约 技术规则或数据细节等 补充规约 技术规则或数据细节等 项目编号由系统自动产生 规则 工程属性 年份 区域 流水号 工程属性 为管理办法中的四个工程类型 本需求中只涉及客户业扩工程 专变 编 号为 ZB 年份用四位表示 如 2009 区域用两位数表示 01 江东 02 江北 03 海曙 流水号用三位数表示 001 例 01 2009 01 001 表示江东局 2009 年专变工程的第一个项目 附件上传部分参加用例 29 工程类别分为以下几种 用户专变 新装 高供高计 新装 高供低计 临时变 增 减 容 事故处理 网内工程 用户工程 网内工程 基建 技改 大修 小区变工程 用户迁移或改道工程 黄色部分不在本期项目内 回退信息的显示 回退人 回退时间 回退内容 回退阶段 按时间倒序 显示 即最近的显示最前面 4 2 功能一功能一 R002业务登记 主要角色经营部业务室 前置条件用户已经登录 后置条件用户将业务记录到系统中 用户操作增加 编辑 删除 提交 江东区经济社会综合统计信息平台需求规格说明书 第 6 页 共 13 页6 引言 功能意图 目 标 相关方法 技 术 典型事件流典型事件流 步骤号步骤号用户用户系统系统 业务信息的增加 修改流程 界面初始时显示系统已有业务登记列 表 选择 新增 修改 功能 载入可填写表单 输入 法人代表 客户名称 联系电 话 联系人 联系地址 税务登记证 开户银行帐号 登记人 登记日期 项目编号 项目名称 工程类别 项 目内容 设计图完工日期 工程竣工 日期 附件上传 表单校验规则 除附件外都是必填项 选择 增加 保存 按扭 表单校验 校验失败时提示 校验成 功时流程继续 服务器成功保存数据 系统显示已有业务登记列表 提示下一阶段的流向选择工程部现场 查勘和物资部设备清单反馈 服务器保存数据失败 系统跳转到异常提示页面 业务信息的删除流程 选择 删除 功能 服务器删除对应数据 系统显示已有业务登记列表 提示数据删除成功 可选 异常事件流可选 异常事件流 补充规约 技术规则或数据细节等 补充规约 技术规则或数据细节等 项目编号由系统自动产生 规则 工程属性 年份 区域 流水号 工程属性 为管理办法中的四个工程类型 本需求中只涉及客户业扩工程 专变 编 号为 ZB 年份用四位表示 如 2009 区域用两位数表示 01 江东 02 江北 03 海曙 流水号用三位数表示 001 例 01 2009 01 001 表示江东局 2009 年专变工程的第一个项目 江东区经济社会综合统计信息平台需求规格说明书 第 7 页 共 13 页 附件上传部分参加用例 29 工程类别分为以下几种 用户专变 新装 高供高计 新装 高供低计 临时变 增 减 容 事故处理 网内工程 用户工程 网内工程 基建 技改 大修 小区变工程 用户迁移或改道工程 黄色部分不在本期项目内 回退信息的显示 回退人 回退时间 回退内容 回退阶段 按时间倒序 显示 即最近的显示最前面 4 3 功能二功能二 R001业务登记 主要角色经营部业务室 前置条件用户已经登录 后置条件用户将业务记录到系统中 用户操作增加 编辑 删除 提交 引言 功能意图 目 标 相关方法 技 术 典型事件流典型事件流 步骤号步骤号用户用户系统系统 业务信息的增加 修改流程 界面初始时显示系统已有业务登记列 表 选择 新增 修改 功能 载入可填写表单 输入 法人代表 客户名称 联系电 话 联系人 联系地址 税务登记证 开户银行帐号 登记人 登记日期 项目编号 项目名称 工程类别 项 目内容 设计图完工日期 工程竣工 日期 附件上传 表单校验规则 除附件外都是必填项 选择 增加 保存 按扭 表单校验 校验失败时提示 校验成 功时流程继续 服务器成功保存数据 系统显示已有业务登记列表 提示下一阶段的流向选择工程部现场 查勘和物资部设备清单反馈 服务器保存数据失败 系统跳转到异常提示页面 业务信息的删除流程 选择 删除 功能 服务器删除对应数据 江东区经济社会综合统计信息平台需求规格说明书 第 8 页 共 13 页8 系统显示已有业务登记列表 提示数据删除成功 可选 异常事件流可选 异常事件流 补充规约 技术规则或数据细节等 补充规约 技术规则或数据细节等 项目编号由系统自动产生 规则 工程属性 年份 区域 流水号 工程属性 为管理办法中的四个工程类型 本需求中只涉及客户业扩工程 专变 编 号为 ZB 年份用四位表示 如 2009 区域用两位数表示 01 江东 02 江北 03 海曙 流水号用三位数表示 001 例 01 2009 01 001 表示江东局 2009 年专变工程的第一个项目 附件上传部分参加用例 29 工程类别分为以下几种 用户专变 新装 高供高计 新装 高供低计 临时变 增 减 容 事故处理 网内工程 用户工程 网内工程 基建 技改 大修 小区变工程 用户迁移或改道工程 黄色部分不在本期项目内 回退信息的显示 回退人 回退时间 回退内容 回退阶段 按时间倒序 显示 即最近的显示最前面 5 角色设置角色设置 列出角色的分类名称 简述各角色的权限 职责范围 6 初始化数据初始化数据 列出系统初始化时需要录入哪些数据 如用户信息初始化等 7 一般约束一般约束 本条各小节对设计系统时限制开发者选择的其它项作一般性描述 而这些 项将限定开发者在设计系统时的任选项 7 1 硬件约束硬件约束 本条包括各种软件运行的硬件约束 如 1 硬件的详细配置 2 硬件的负载 如只运行本系统 还是和其它系统共用 江东区经济社会综合统计信息平台需求规格说明书 第 9 页 共 13 页 7 2 安全性安全性 说明如何保护软件 以防止偶然或恶意的访问 使用 修改或泄密 这个 领域的具体需求必须包括 1 利用可靠的密码技术 2 防止 SQL 注入 3 区分用户权限 4 选择性的是使用 CA 证书 7 3 可用性可用性 可以指定一些因素 如检查点 恢复和再启动等 以保证整个系统有一个 确定的可用性级别 即当系统出现异常时执行什么样的操作能保证系统再次正 常运行 以及这种操作是否有何种负面影响 7 4 性能性能要求要求 本条说明软件数据处理能力和时间特性的需求 数据处理能力可能包括 支持的终端数 支持并行操作的用户数 处理的 文件和记录数 表和文件的大小 时间特性可能包括 响应时间 更新处理时间 数据的转换和传送时间 运行时间等 7 5 数据库要求数据库要求 本条说明对软件应用的数据库的需求 如 数据库名称 版本 数据项 记录 文件标识 静态和动态的组织 存取能力等 存储特性 数据库的编码方式 备份方式 可能的最大字节数 7 6 管理维护方针管理维护方针 描述软件启动 关闭的管理方式 描述软件内容日常维护 管理的方式 7 7 并行操作并行操作 本条描述是否存在两个用户同一时刻操作同一条数据库记录的可能性 以 及在这种情况是否要实现数据的保护 同步 7 8 可移植性可移植性 说明软件对软 硬件环境的兼容 它从一个环境移植到另一个环境的约束 江东区经济社会综合统计信息平台需求规格说明书 第 10 页 共 13 页10 等 7 9 其它标准的约束其它标准的约束 本条描述由现有的标准或规则派生的要求 如 1 报表格式 2 数据命名 3 会计准则 4 审计追踪等等 8 外部接口要求外部接口要求 8 1 用户接口用户接口 本条说明为方便用户使用而提出的软件与用户界面的需求 如 1 屏幕格式 2 浏览器支持类型 3 报表格式 4 菜单格式 5 功能键的使用 如回车等快捷键 6 表单的操作要求 如回车提交 TAB 切换等 8 2 硬件接口硬件接口 本条说明软件与硬件间各接口 可使用接口框图进行说明 说明内容包括 1 接口标识 2 功能描述 3 信号方向 格式 传输协议 4 优先级 5 响应时间 6 异常处理 对每一硬件 需提供名称 缩写 型号 数量 并说明其功能 8 3 软件接口软件接口 本条指定需使用的其他软件产品 如 数据管理系统 操作系统 数学软 江东区经济社会综合统计信息平台需求规格说明书 第 11 页 共 13 页 件包 以及同其他应用系统之间的接口 如果已有完整的接口文件 需在本 条指明 说明内容包括 1 接口标识 2 功能描述 3 数据流程和控制流程的方向 4 数据格式 容量 5 接口类型 如手动或自动 6 接口数据中断的优先级别 7 中断响应时间 8 异常处理等 对每一个所需的软件产品 需提供名称 缩