概要设计说明书模板

概要设计说明书

（文档编号：                   ）

公司

实施部门：

项目经理：

生效日期：

XXX项目

概要设计说明书

文档编号：                版本：

1. 概述

1.1系统简介

简要描述本系统基本情况。

1.2系统目标

描述概要设计所要实现的目标，包括功能目标、性能目标等。

1.3系统设计原则

列举系统设计时遵循的基本理论或基本原则，例如面向对象的系统分析原则、逐步求精原则等。

根据用户需求和系统设计原则，对设计要点进行优先级排序（注：一定要分出优先次序，不能有任何两项平级），要点可包括：体积大小size、速度speed、可靠性robustness、安全性safety、易测试性testability、易维护性maintainability、可复用性reusability、可移植性portability等。

1.4系统运行环境

包括对硬件平台、操作系统、数据库系统、中间件平台、编程平台、网络和外围设备、网络传输介质和网络协议的描述。

对于B/S或C/S结构需要分别指出各部分的运行环境。

1.5开发环境

列举项目组进行系统分析、程序设计和程序开发时要使用的工程工具和开发语言。应描述每一工具软件的名称、版本等。

2. 总体结构

2.1系统部署

2.1.1系统拓扑结构图

以图形方式给出该软件产品在用户方部署时，预期的网络和硬件部署结构，以及系统和其他系统间的部署关系等。

涉及网络结构时，建议使用网络拓扑图方式描述。对软件运行时需要配置的计算机或其他外部设备，均应以图形方式加以描述。

2.1.2系统部署说明

对上面的系统部署图中每个系统设备的功能加以必要的描述，说明该设备的基本配置要求，其上运行的操作系统名称和版本，应用程序的名称和版本等。

2.2软件部署

描述应用软件体系部署，可以包括设计思想、部署图、软件架构说明、层次结构等方面。

3. 数据流程

3.1数据流程图

以图形方式描述系统整体的数据流转情况及数据处理行为，数据流程图格式应符合软件工程的一般标准。

3.2数据流程图说明

对上面的数据流程图中每个数据流转或数据处理环节加以必要的解释和说明。

3.3数据字典

4. 系统模块设计

4.1子系统模块结构图

以图形方式给出软件系统的子系统（或软件包）划分，模块划分，子系统间、模块间关系等。结构图格式应符合软件工程的一般标准。

（注意：一般应在系统结构中包含“发布子系统”，即通常所说的安装程序或其他形式的发布程序，在下面的“子系统模块概要设计”中也应包含“发布子系统”的概要设计说明。）

4.2子系统模块概要设计

对“子系统模块结构图”中出现的每个子系统或模块，描述以下内容：

名称和版本。

子系统或模块的内部编号（编号格式由项目组自定）。

表现形式（以何种形式运行，如服务程序、应用程序、COM组件、数据库脚本、JSP程序等等）。

功能描述。

处理流程图（对较简单的模块，在前面“功能描述”中已可以准确定义该模块功能的，可省略功能流程图）

子系统模块有无人机交互界面，如有，则给出该子系统-模块人机交互界面的类型（如普通Web界面、普通GUI界面、Java Applet界面、Java Swing界面、字符终端界面、命令行界面等）和设计原则（界面风格、基本操作方式等）。

与其他子系统或模块的接口（描述每个接口的名称、输入信息、输出信息、异常处理等）。

实现方式（以何种开发工具，何种开发语言实现该子系统或模块）。

实现思路（给出实现该模块的基本思路，包括对模块内部结构、算法、编程方法等的初步设想）。

5. 数据库设计

此节描述存储在通用数据库中的数据，或存储在硬盘、磁带、光盘等永久性存储介质上，但存储格式与通用数据库相同的数据。

如果系统不以数据库方式存储数据，则此节可省略。

5.1结构概要

描述数据库的系统设置、表空间分配、用户权限设置等概要信息。

5.2表结构

必要时，可用单独的文档（如，《XXX数据库结构设计》）来描述数据库设计。

对不需要单独的文档来描述数据库设计的，对系统使用的每一种数据库表或数据库视图，给出下面的表格，描述其内部结构：

永久性数据指系统运行过程中，存储于硬盘、磁带、光盘等永久性存储介质上，并且存储时间相对较长的数据（不包括那些为实现某种功能算法，临时在硬盘上存储的数据，也不包括按照通用数据库格式存储的数据）。

如果系统不使用永久性数据，则此节可省略。

6.1文件组织结构

指文件在存储介质上的目录层次、目录命名、文件类型、文件命名等内容。

6.2文件结构

精确描述每种数据文件的内部结构。此项内容无特定格式要求。

6.3数据备份、恢复

描述系统数据备份、恢复的方式、方法。

7. 系统业务功能设计

针对系统实现的业务功能，阐述其业务内容和实现方案。

7.1业务内容

对该业务功能的内容进行概要说明。

7.2处理流程

简单说明该业务的处理步骤及处理方法。对于复杂的流程，可以用流程图的方式进行说明；对于简单的、流线型的处理流程可以分步骤进行说明。

8. 其它设计

对以上概要设计中未包含项目的说明，如并行处理、安全设计、内存管理等。

9. 术语表

以字典形式给出该软件系统中使用的，有必要显示说明的术语名称及其解释，必要时，还可以给出该术语的英文译名、参考文献等信息。

变更记录