概要设计说明书编写规范.doc

概要设计说明书编写规范 案卷号 日期 ＜XX集团网络化运营系统＞ 概要设计说明书 作 者 王立峰 完成日期 2000/11/3 签 收 人 签收日期 修改情况记录 版本号 修改批准人 修改人 安装日期 签收人 目录 1 引言1 1.1 编写目的1 1.2 范围1 1.3 定义1 1.4 参考资料1 2 总体设计1 2.1 需求规定1 2.2 运行环境2 2.3 基本设计概念和处理流程2 2.4 结构2 2.5 功能需求与程序的关系2 2.6 人工处理过程2 2.7 尚未解决的问题3 3 接口设计3 3.1 用户接口3 3.2 外部接口3 3.3 内部接口3 4 运行设计3 4.1 运行模块组合3 4.2 运行控制3 4.3 运行时间4 5 系统数据结构设计4 5.1 逻辑结构设计要点4 5.2 物理结构设计要点4 5.3 数据结构与程序的关系4 6 系统出错处理设计5 6.1 出错信息5 6.2 补救措施5 6.3 系统维护设计5 概要设计说明书编写规范 1 引言 1.1 编写目的 服务于XX集团网络化运营，管理销售中的各个环节，最终用户为XX集团销售公司,销售办事处和集团领导。 1.2 范围 说明 a． 待开发的软件系统的名称； b． 列出本项目的任务提出者、开发者、用户以及将运行该项软件的单位。 1.3 定义 列出本文件中用到的专门术语的定义和缩写词的原词组。 1.4 参考资料 列出要用到的参考资料，如 a． 本项目的经核准的计划任务书或合同、上级机关的批文； b． 属于本项目的其他已发表的文件； c． 本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 总体设计 2.1 需求规定 说明对本系统的主要的输入输出项目、处理的功能性能要求，详细的说明可参见需求分析说明书。 2.2 运行环境 简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定，详细说明参见需求分析说明书。 2.3 基本设计概念和处理流程 说明本系统的基本设计概念和处理流程，尽量使用图表的形式。 2.4 结构 用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系。 2.5 功能需求与程序的关系 本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系 程序1 程序2 ．．．．．． 程序m 功能需求1 √ 功能需求2 √ ．．．．．． 功能需求n √ √ 2.6 人工处理过程 说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。 2.7 尚未解决的问题 说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。 3 接口设计 3.1 用户接口 说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。 3.2 外部接口 说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。 3.3 内部接口 说明本系统之内的各个系统元素之间的接口的安排。 4 运行设计 4.1 运行模块组合 说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。 4.2 运行控制 说明每一种外界的运行控制的方式方法和操作步骤。 4.3 运行时间 说明每种运行模块组合将占用各种资源的时间。 5 系统数据结构设计 5.1 逻辑结构设计要点 给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。 5.2 物理结构设计要点 给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。 5.3 数据结构与程序的关系 说明各个数据结构与访问这些数据结构的各个程序之间的对应关系，可采用如下的矩阵图的形式 程序1 程序2 ．．．．．． 程序m 数据结构1 √ 数据结构2 √ ．．．．．． 数据结构n √ √ 6 系统出错处理设计 6.1 出错信息 用一览表的方式说明每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。 6.2 补救措施 说明故障出现后可能采取的变通措施，包括 a． 后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术； b． 降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录； c． 恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。 6.3 系统维护设计 说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。 第 5 页