10-SZY01-需求规格说明书模板v20.pdf

国家水资源监控能力建设项目国家水资源监控能力建设项目 2012 2014 年 年 SZY610 2013 需求规格说明书模板 Requirement Specification Template 试行 文件编号 SZY01 MWR PM RST DHC V2 0 当前版本 2 0 编制单位 DHC 发布日期 2013 06 24 北京东华合创科技有限公司北京东华合创科技有限公司 编制编制 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 I 前言 本规范是对国家水资源监控能力建设项目的项目标准的补充 用于规范需求 规格说明书的编写 为项目承建商编写需求规格说明书提供文档模式参考 本文档模板由国家水资源监控能力建设项目办公室提出 本文档模板由国家水资源监控能力建设项目办公室归口 本文档模板由北京东华合创科技有限公司负责编制 本文档模板由北京东华合创科技有限公司负责解释 主要起草人员 张绍夫 靳春平 朱洪欣 张振 陈星晓等 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 II 目目 录录 前言前言 I I 第一章第一章 引言引言 1 1 1 1 目的 1 1 2 定义 1 1 2 1 术语 1 1 2 2 缩略语 1 1 2 3 标识符定义 2 1 3 参考资料 2 1 4 描述约定 2 第二章第二章 总体需求分析总体需求分析 3 3 2 1 软件 系统 基本信息 3 2 2 建设任务与目标 3 2 3 总体要求 3 2 4 软件 系统 构成与边界定位 3 2 5 约束条件分析 3 第三章第三章 软件 系统 名称 软件 系统 名称 1 1 需求分析 需求分析 4 4 3 1 系统总体分析 4 3 1 1 系统定位与目标 4 3 1 2 业务流程描述 4 3 2 功能需求分析 5 3 2 1 功能需求一览表 5 3 2 2 子系统功能 1 6 3 2 3 子系统功能 2 11 3 3 非功能需求 13 3 3 1 系统性能需求 13 3 3 2 数据需求 14 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 III 3 3 3 故障处理需求 14 3 3 4 安全性要求 14 3 3 5 运行环境需求 15 3 3 6 其他专门需求 15 3 4 接口关系 15 第四章第四章 软件 系统 名称 软件 系统 名称 2 2 需求分析 需求分析 1616 第五章第五章 需求可追踪性需求可追踪性 1717 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 1 第一章第一章 引言引言 1 1 目的目的 在此 说明编写需求规格说明书的目的 概括需求规格说明书的用途和内容 指出预期的读者 1 2 定义定义 1 2 1 术语术语 描述需求规格说明书中涉及的术语含义 例如 活动节点 在业务流程中 流程任何支路的终端或流程中两个或更多支路的互连公共 点 1 2 2 缩略语缩略语 描述需求规格说明书中涉及的缩略语的全称及其含义 例如 序号序号 缩写缩写 英文名称英文名称 中文名称中文名称 1 SRS Software Requirement Specification 软件需求规格说明书 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 2 1 2 3 标识符定义标识符定义 描述本系统涉及的接口标识符和功能标识符的定义 1 3 参考资料参考资料 本节应列出编写需求规格说明书时所引用所有文档的编号 标题 修订版本 和日期 也应标识所有文档的来源 1 4 描述约定描述约定 1 所有图例采用 Visio 软件相应模型进行绘制 有特殊要求的图例除外 在提交需求规格说明书时需要提供相应 vsd 格式的源文件 源文件名称需与需 求规格说明书中相应图例的名称及编号保持一致 功能组成图采用基本框图模式绘制 业务流程图采用跨职能流程图模式绘制 运行环境部署图采用 UML 部署图形状绘制 绘制过程中采用的网络符号采用 Visio 中的 网络 形状中的相应符号 其它 2 用例图 活动图使用 rose 软件相应模块进行绘制 在提交需求规格说 明书时需要提供相应 mdl 格式的源文件 源文件名称需与需求规格说明书中相 应图例的名称及编号保持一致 3 其它采用非 Visio 或 rose 软件绘制的图例要求同上 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 3 第二章第二章 总体需求总体需求分析分析 本节对软件 系统 的需求进行详细描述 包括软件 系统 的基本信息 建设背景 建设任务与目标 需要实现的功能 流程 接口和性能等需求 2 1 软件 系统 基本信息软件 系统 基本信息 描述项目软件 系统 的名称 业主 建设内容 进度要求 承建单位等信 息 2 2 建设任务与目标建设任务与目标 分条目描述本项目软件 系统 的建设任务与建设的目标 2 3 总体要求总体要求 分条目描述项目软件 系统 的软件技术架构要求 应遵循的标准规范要求 应符合的项目要求等等 2 4 软件 系统 软件 系统 构成与边界定位构成与边界定位 分条目描述本软件 系统 与国家水资源监控能力建设项目 2012 2014 年 之间的关系 本软件 系统 的边界定位以及本软件 系统 与其他业务系统之 间的关系 2 5 约束条件分析约束条件分析 给出约束系统设计 开发定制的各种条件 比如范围 技术 工作方法 建 设策略 项目周期等方面的约束条件 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 4 第三章第三章 软件 系统 软件 系统 名称名称 1 需求需求分析分析 本章节应分条详细描述与软件 系统 每一功能相关联的需求 本章节应标识必需的每一系统功能 并详细说明与该功能有关的需求 包括 功能描述 功能组成模块以及功能组成模块的描述 用例图 活动图及其活动说 明等 在确定与系统所接收的输入和系统所产生的输出有关的需求时 给出输入 输出列表 如果该功能还可以更清晰的分解成若干子功能 则应分条对子功能进行说 明 注 层级划分原则是可以把需求清晰的描述出来即可 3 1 系统总体分析系统总体分析 本模板按照系统 子系统 模块 功能单元 子功能单元为例进行划分 实 际系统可以按照具体需求进行适当扩展和删减 但是最后一个层级必须包括功能 描述 用例构成分析 输入输出分析 业务活动分析以及处理过程分析以及性能 约束部分 比如 在本模板中的子功能单元这一层级必须包括功能描述 用例构 成分析 输入输出分析 业务活动分析以及处理过程分析以及性能约束部分 3 1 1 系统定位与目标系统定位与目标 描述本软件 系统 在本项目中承担的职责与作用 以及本软件 系统 需 要实现的目标 3 1 2 业务流程描述业务流程描述 以图表的形式在此对本软件 系统 的总体业务流程进行描述 如果存在子 流程或转接流程 也应在此进行详细说明 若子流程或转接流程将在以下相应子 系统或模块中说明 则应在此加以注明 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 5 以单节点内部流转的业务流程为例 描述本系统的总体业务流程 业务流程 编 写 规 则详 见 业 务 流 程编 写 规范 编 号 SZY01 MWR PM BPCS DHC V1 0 视图编写规则详见 视图编写规范 编 号 SZY01 MWR PM VCS DHC V1 0 单位 岗位及角色编码规则参见 信 息代码编制规定 应用系统名称应用系统名称 角色角色1角色角色2角色角色n 部门部门m m部门部门1 1部门部门2 2 节点节点2 2 XXXX活动活动 流程编号流程编号 SZYSZY ISIS BPBP PAPA 001001流程名称流程名称 XXXXXXXXXX业务流程业务流程 编制编制 XXXXXX 编制日期编制日期 2020XXXX年年XXXX月月XXXX日日 审核审核 XXXXXX 审核日期审核日期 20XX年年XX月月XX日日 图例说明图例说明 版本编号版本编号 1 1 0 0 1 1 V V002002 xxxx视图视图 节点节点4 4 XXXX活动活动 V V004004 xxxx视图视图 节点节点5 5 XXXX活动活动 V V005005 xxxx视图视图 节点节点1 1 XXXX活动活动 V V001001 xxxx视图视图 节点节点3 3 XXXX活动活动 V V003003 xxxx视图视图 在此处按照活动节 点编号本业务流程 进行描述 活动节点活动节点 判定判定 包含子流程的活动节点包含子流程的活动节点 活动节点产生的表单活动节点产生的表单 流程描述流程描述 转接流程转接流程 T T002002 T T002002 图 1 xxx系统总体业务流程示意图 具 体 业 务 流 程 描 述 规 范 详 见 业 务 流 程 编 写 规 范 SZY01 MWR PM BPCS DHC V1 0 3 2 功能需求功能需求分析分析 3 2 1 功能需求一览表功能需求一览表 在此描述本软件 系统 的功能组成以及组成结构图 要求组成结构图需要 详细至最细颗粒度 比如 在此需要详细至子功能单元 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 6 3 2 2 子系统功能 子系统功能 1 1 功能描述功能描述 在此进行本子系统功能模块的划分 同时对个功能模块的主要功能进行介 绍 2 功能划分功能划分 在此进行本子系统详细的功能模块图 示例如下 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 7 图 2 xxx子系统功能组成示意图 3 数据流图数据流图 在此对本子系统的数据流进行详细描述 如果存在子流程或转接流程 也应 在此进行详细说明 若子流程或转接流程将在以下相应模块中说明 则应在此加 以注明 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 8 数据流图的表述方法与业务流程图类似 故可以参考业务流程编写规范 详 见 业务流程编写规范 SZY01 MWR PM BPCS DHC V1 0 3 2 2 1 功能模块名称 功能模块名称 1 1 功能描述功能描述 在此进行功能模块的功能描述 并对该功能模块包含的功能单元进行描述 2 数据 数据流流图图 在此对本功能模块的数据流程进行详细描述 如果存在子流程或转接流程 也应在此进行详细说明 若子流程或转接流程将在以下相应功能单元中说明 则 应在此加以注明 数据流图的表述方法与业务流程图类似 故可以参考业务流程编写规范 详 见 业务流程编写规范 SZY01 MWR PM BPCS DHC V1 0 3 2 2 1 1 XXX 功能单元功能单元 1 在本章节中 应分条目对本功能单元包括的子功能单元在功能描述 用例图 输入输出 活动图以及过程说明等方面进行阐述 3 2 2 1 1 1 XXX 子功能单元子功能单元 1 在此进行该子功能单元的功能描述 包括该子功能单元的单元描述 用例图 输入输出表 活动图以及活动图的过程说明 具体的描述模式说明如下 1 功能描述 在此对本子功能单元的功能进行详细的描述 表明本子单元需要实现的功 能 2 用例构成分析 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 9 使用 rose 软件给出本子功能单元的用例图 并在此对用例图给出解释 详 细用例图编写规则参见 用例图编写规范 SZY01 MWR PM USDCS DHC V1 1 示例如下 仅供参考 用例图 1 XX 子功能单元用例图 3 输入输出分析 在此对本子功能单元的输入输出项以输入输出表的形式进行说明 在不影响 对子功能单元输入输出的描述清晰度的条件下 可以对下表中的输入输出项的条 目进行适当删减 表格 1 xxx功能单元输入输出表 序号序号 I O 项项 名称名称 内容内容描述描述 备注备注 1 In 2 3 Out 4 4 业务活动分析 在此按照 UML 活动图的模式给出本子功能单元的活动图 详细活动图编写 规则详见 活动图编写规范 SZY01 MWR PM ADCS DHC V1 0 示例如下 本例仅供参考 不涉及具体内容的正确与否 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 10 活动图 1 门户首页静态化子功能单元活动图 5 处理过程分析 在此对活动图的过程进行说明 处理过程描述要求对活动图给出尽量详细的 说明 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 11 表格 2 xxx子功能单元处理过程表 处理过程名称 子功能单元 处理过程名称 子功能单元 序号序号 活动过程描述活动过程描述 备注备注 1 2 3 4 5 6 性能约束 发生错误或异常时 将如何提示用户 3 2 2 1 1 2 XXX 子功能单元子功能单元 2 当子功能单元的个数多于 1 则使用本章节 并且本章节可以重复重复使用 本节文档结构参照第 3 2 2 1 1 1 节 3 2 2 1 2 XXX 功能单元功能单元 2 当功能单元的个数多于 1 则使用本章节 并且本章节可以重复重复使用 本节文档结构参照第 3 2 2 1 1 节 3 2 2 2 功能模块名称 功能模块名称 2 当功能模块的个数多于 1 则使用本章节 并且本章节可以重复重复使用 本节文档结构参照第 3 2 2 1 节 3 2 3 子系统功能 子系统功能 2 当子系统个数多于 1 则使用本章节 并且本章节可以重复重复使用 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 12 本节文档结构参照第 3 2 2 节 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 13 3 3 非功能需求非功能需求 3 3 1 系统性能需求系统性能需求 3 3 1 1 精度要求精度要求 说明对该系统的输入 输出数据精度的要求 可能包括传输过程中的精度 3 3 1 2 时间特性要求时间特性要求 说明对于该系统的时间特性要求 比如 1 响应时间 2 更新 处理时间 3 数据的转换和传送时间 3 3 1 3 灵活性灵活性 说明对该系统的灵活性的要求 即当需求发生某些变化时 该系统对这些变 化的适应能力 如 1 操作方式上的变化 2 运行环境的变化 3 同其他系统的接口的变化 4 精度和有效时限的变化 5 计划的变化或改进 对于为了提供这些灵活性而进行的专门设计的部分应该加以标明 3 3 1 4 易用性易用性 本章节 对交互的适应性 功能性和有效性进行集中体现 易用性包含易理 国家水资源监控能力建设项目 2012 2014 年 XXX 需求规格说明书 北京东华合创科技有限公司编制 14 解性 易学习性和易操作性 即易用性是指在指定条件下使用时 软件产品被理 解 学习 使用和吸引用户的能力 3 3 2 数据需求数据需求 本节应指明分配给系统内部数据的需求 包括对系统中数据库和数据文件的 需求 说明需要管理的文卷和记录的个数 表和文卷的大小规模 要按可预见的 增长对数据及其分量的存储要求做出估算 解释各输入输出数据类型 并逐项说明其媒体 格式 数值范围 精度等 对软件的数据输出及必须标明的控制输出量进行解释并举例 包括对硬拷贝报告 正常结果输出 状态输出及异常输出 以及图形或显示报告的描述 3 3 3 故障处理需求故障处理需求 本节说明在本系统发生可能的软硬件故障时 对故障处理的要求 3 3 3 1 软件系统出错处理软件系统出错处理 1 说明属于软件系统的问题 2 给出发生错误时的错误信息 3 说明发生错误时可能采取的补救措施 3 3 3 2 硬件系统冗余措施的说明硬件系统冗余措施的说明 1 说明哪些问题可以由硬件设计解决 并提出可采取的冗余措施 2 对硬件系统采取的冗余措施加以说明 3 3 4 安全性要求安全性要求 在此 描述本软件 系统 对安全方面的需求 比如 网络安全要求 软硬 国家水资源监控能力