软件项目概要设计说明书

概要设计说明书 文档编号 CGN IT C3 A05 04 1 8 中国广东核电集团中国广东核电集团 C CH HI IN NA A G GU UA AN NG GD DO ON NG G N NU UC CL LE EA AR R P PO OW WE ER R G GR RO OU UP P 记记 录录 文文 件件 项项目目编编号号 项项目目名名称称 C CG GN N I IT T C C3 3 A A0 05 5 0 04 4 概概要要设设计计说说明明书书 版本编写审核审定批准生效时间 A 0 注 如无受控文件标识 蓝色印章 则为非有效版本 以受控文件规定为准 此文件属中国广东核电集团有限公司所有 未经许可 不得以任何方式外传 概要设计说明书 文档编号 CGN IT C3 A05 04 2 8 修改记录页修改记录页 NO修改日期修改摘要 涉及页码 条款 内容 版本修改原因 模板使用必读 模板内容和页眉中 包含内容为指导性的待替换文字 请在使用中替 换为具体内容 或删除 文件提交时不得再含有这些内容 概要设计说明书 文档编号 CGN IT C3 A05 04 3 8 目目 录录 1引言 3 1 1编写目的 3 1 2背景 4 1 3术语与缩写解释 4 1 4参考资料 4 2概述 4 2 1系统任务 4 2 1 1系统目标 4 2 1 2运行环境 4 2 1 3与其它系统关系 5 2 2需求规定 5 2 2 1功能需求 5 2 2 2非功能性需求 5 2 2 3安全设计 5 2 2 4约束和假定 5 3架构设计 5 3 1基本设计概念和处理流程 5 3 2软件系统结构 6 3 2 1模块 A 6 3 2 2模块 B 6 3 3功能需求与系统模块的关系 6 3 4数据结构设计 6 3 4 1逻辑结构设计要点 6 3 4 2物理结构设计要点 6 3 4 3数据结构与程序的关系 7 4系统出错处理设计 7 4 1出错信息 7 4 2补救措施 7 5系统维护设计 8 6尚未解决的问题 8 概要设计说明书 文档编号 CGN IT C3 A05 04 4 8 1 1 引言引言 1 11 1 编写目的编写目的 给出项目概要设计说明书的编写目的 同时指明读者对象 1 21 2 背景背景 标识要开发的软件产品 名称 代码 列出此项目的任务提出者 开发者 用户 以及将运行该软件的计算站 中心 1 31 3 术语与缩写解释术语与缩写解释 列出本文件中用到的专门术语的定义和外文首字母缩写的原词组 缩写 术语缩写 术语解解 释释 PMO 项目管理办公室 Project Management Office PP 项目策划 规划 Project Planning 1 41 4 参考资料参考资料 提示 可包括 1 本项目经核准的计划任务书 需求规格说明书 合 同或上级机关的批文 2 本文档所引用的资料 规范等 列出这些资料的作 者 标题 编号 发表日期 出版单位或资料来源 概要设计说明书 文档编号 CGN IT C3 A05 04 5 8 2 2 概述概述 2 12 1 系统任务系统任务 2 1 12 1 1系统目标系统目标 说明本系统将要实现的目标 2 1 22 1 2运行环境运行环境 简要地说明对本系统的运行环境的规定 包括所需的硬件设备和支持软 件 2 1 32 1 3与其它系统关系与其它系统关系 当前系统是某一软件产品的一部分 或者与其它系统有密切关联时 说 明相互间的关系 2 22 2 需求规定需求规定 说明对本系统的主要的输入 输出项目 处理的功能和性能要求 以及需 求说明书中明确的其它专门要求 2 2 12 2 1功能需求功能需求 2 2 22 2 2非功能性需求非功能性需求 2 2 32 2 3安全设计安全设计 2 2 42 2 4约束和假定约束和假定 描述系统设计中最主要的约束 这些是由客户强制要求并在需求说明书 概要设计说明书 文档编号 CGN IT C3 A05 04 6 8 写明的 说明系统是如何来适应这些约束的 另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功能 辅助 那么系统可能还受到其它的约束 这种情况下 要求清楚地描述与本系 统有交互的软件类型以及这样导致的约束 3 3 架构设计架构设计 3 13 1 基本设计概念和处理流程基本设计概念和处理流程 说明本系统的基本设计概念和处理流程 尽量使用图表的形式 3 23 2 软件系统结构软件系统结构 用一览表及框图的形式说明本系统的系统元素 各层模块 子程序 公 用程序等 的划分 扼要说明每个系统元素的标识符和功能 分层次地给出各 元素之间的控制与被控制关系 3 2 13 2 1模块模块 A A 3 2 23 2 2模块模块 B B 3 33 3 功能需求与系统模块的关系功能需求与系统模块的关系 本条用一张如下的矩阵图说明各项功能需求的实现同各模块的分配关系 系统模块 1系统模块 2 系统模块 m 功能需求 1 功能需求 2 功能需求 n 概要设计说明书 文档编号 CGN IT C3 A05 04 7 8 3 43 4 数据结构设计数据结构设计 3 4 13 4 1逻辑结构设计要点逻辑结构设计要点 给出本系统内所使用的每个数据结构的名称 标识符以及它们之中每个 数据项 记录 文卷和系的标识 定义 长度及它们之间的层次的或表格的相 互关系 3 4 23 4 2物理结构设计要点物理结构设计要点 给出本系统内所使用的每个数据结构中的每个数据项的存储要求 访问 方法 存取单位 存取的物理关系 索引 设备 存储区域 设计考虑和保密 条件 3 4 33 4 3数据结构与程序的关系数据结构与程序的关系 说明各个数据结构与程序的关系 可采用下图形式进行说明 程序 1程序 2 程序 m 数据结构 1 数据结构 2 数据结构 n 4 4 系统出错处理设计系统出错处理设计 4 14 1 出错信息出错信息 用一览表的方式说明每种可能的出错或故障情况出现时 系统输出信息 的形式 含意及处理方法 概要设计说明书 文档编号 CGN IT C3 A05 04 8 8 4 24 2 补救措施补救措施 说明故障出现后可能采取的补救措施 包括 a 说明准备采用的后备技术 当原始系统数据万一丢失时 启用的副本的 建立和启动的技术 例如 周期性地把磁盘信息记录到磁带上去就是对 于磁盘媒体的一种后备技术 b 说明准备采用的降效技术 使用另一个效率稍低的系统或方法来求得所 需结果的某些部分 例如一个自动系统的降效技术可以是手工操作和数 据的人工记录 c 说明将使用的恢复再启动技术 使软件从故障点恢复执行或使软件从头 开始重新运行的方法 5 5 系统