概要设计说明书模板-v1.0.0.docVIP

概要设计说明书模板 目 录 第一章 导言 2 1.1 目的 2 1.2 范围 2 1.3 命名规则 2 1.4 术语定义 2 1.5 相关文档 3 1.6 参考资料 3 第二章 总体结构设计 5 2.1 总体结构图设计 5 2.2 运行环境设计 5 2.3 子系统清单 6 2.4 功能模块清单 6 第三章 模块（部件）功能分配 7 3.1 专用模块功能分配 7 3.2 公用模块功能分配 7 3.3 模块的关系 7 第四章 全局数据结构设计 7 4.1 数据库表名清单 8 4.2 数据库表之间关系说明 8 4.3 数据库表的详细清单 8 4.4 视图的设计 8 4.5 数据结构和程序的关系 8 4.6 主要算法设计 8 4.7 其它数据结构设计 8 第五章 外部接口设计 9 5.1 外部接口1设计 9 5.2 外部接口2设计 9 第六章 运行设计 9 6.1 运行模块组合 10 6.2 运行控制 10 6.3 运行时间 10 第七章 出错处理设计 10 7.1 出错输出信息 10 7.2 出错处理对策 10 第八章 其它设计 11 文档类别使用对象 文档类别 本文档是软件系统概要设计说明书的模板，是概要设计说明书的书写标准及规范，是技术文档。 使用对象 该文档使用人员包括： 系统分析人员 系统设计人员 系统编码人员 系统测试人员 系统维护人员 导言 本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。 目的 本文档的目的旨在推动软件工程的规范化，使设计人员遵循统一的概要设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。 范围 本文档用于软件设计阶段的概要设计，它的上游（依据的基线）是需求分析规格书，它的下游是系统详细设计说明书，并为详细设计说明书提供测试的依据。 软件概要设计的范围是：软件系统总体结构、外部接口、主要部件功能分配、全局数据结构以及部件之间的接口等方面的内容。 命名规则 变量对象命名规则 申明全局变量、局部变量对象的命名规则。 数据库对象命名规则 申明数据库表名、字段名、索引名、视图名对象的命名规则。 术语定义 序号 术语名称 术语定义 1 总体结构 软件系统的总体逻辑结构。按照不同的设计方法，有不同的总体逻辑结构。若采用传统的面向功能或面向数据的结构化设计方法，则总体逻辑结构为一树形的功能模块结构图。若采用时尚的面向对象或面向部件（组件）的设计方法，则总体逻辑结构为部件（组件）的组装图。 2 外部接口 本软件系统与其它软件系统之间的接口，接口设施可以是中间件。接口描述包括：传输方式、带宽、数据结构、传输频率、传输量（兆/秒）、传输协议。 3 数据结构 数据结构包括：关系数据库表的结构、对象数据库表的结构、变量说明。 4 概念数据模型 关系数据库的逻辑设计模型，叫概念数据模型。主要内容包括一张逻辑E--R图及其相应的数据字典。 5 物理数据模型 关系数据库的物理设计模型，叫物理数据模型。主要内容包括一张物理表关系图及其相应的数据字典。 6 视图 在基表之上建立的一张虚表，叫视图，它具有物理表的许多性质，在授权上很有用。 7 角色 数据库中享有某些特权操作的用户，叫角色。 8 子系统 具有相对独立功能的小系统叫子系统。一个大的软件系统可以划分为多个子系统，每个子系统可由多个模块或多个部件组成。 9 模块 具有功能独立、能被调用的信息单元叫模块。模块是结构化设计中的概念。 10 部件（组件） 具有功能独立、能被调用的、且已包装的信息单元叫部件（组件）部件是面向对象设计中的概念。 11 内部接口 软件系统内部各子系统之间、各部件之间、各模板之间的接口，叫内部接口。接口描述包括：调用方式、入口信息、出口信息等。 12 相关文件 相关文件是指：当本文件内容变更后，可能引起变更的其它文件。如需求分析报告、详细设计说明书、测试计划、用户手册。 13 参考资料 参考资料是指：本文件书写时用到的其它资料。如各种有关规范、模板、标准、准则。 相关文档 详细设计说明书 源程序清单 测试计划及报告 用户使用手册 参考资料 用户需求分析报告 软件开发合同 数据库设计规范 命名规范 总体结构设计 总体结构图设计 软件系统的总体逻辑结构，按照不同的设计方法，有不同的总体逻辑结构。本指南以结构化设计方法为主，画出系统总体结构图，列出系统的功能模块清单编号、名称、功能，并尽可能描绘出功能模块之间的关系。若用面向对象的ROSE工具进行分析和设计，则遵照ROSE的要求进行。 关于总体结构图的说明如下： 运行环境设计 该软件系统的运行环境： 硬件平台： 服务器的最低配置要求 工作站的最低配置要求 外设的要求 软件平台