概要设计说明书

概要设计说明书编写指南

文件编号：CP/B05-C03

版本号：V1.0.0

受控状态：受控

发放号：

编制部门：

编制人：编制日期：

审核人：审核日期：

批准人：批准日期：

×××公司发布

变更记录

注：对该文件内容增加、删除或修改均需填写此变更记录，详细记载变更信息，以保证其可追溯性。

文档变更记录

序号修改条款修改说明页号修改人/日期批准人/日期备注

注：对本文档内容增加、删除或修改均需填写此变更记录，详细记载变更信息，以保证其可追溯性。

评审记录

评审名称评审时间

评审地点记录人

评审方式会议式（）传阅式（）批准式（）其它

对象

目的

（可附后）

评审

内容

评审

意见

评审

结论

备注

参评人签字职务参评人签字职务参评人签字职务批准人批准日期

1. 引言

1.1 目的

概述本文档的编写目的、主要阐述内容以及通过编写此文档能够达到的目的。

1.2 范围

概述本文档适用的范围以及预期读者。

1.3 定义、首字母缩写词和缩略语

建议提供全部术语、缩写词及略语的定义，以便对本文档进行适当的解释。

1.4 参考资料

建议按文档号和标题列出本报告引用的所有文档，包括所使用的标准等。

2. 整体说明

2.1 系统概述

简要介绍系统开发背景、目的和意义、应用目标等相关情况。

2.2 系统结构

2.2.1 功能结构

以系统用例图、系统模块组成图或系统逻辑关系图等方式描述系统功能组成，同时对图中每个组成部分以文字方式进行简要说明。

2.2.2 技术结构

简要介绍系统采用的技术路线、技术手段、整体技术架构及实现思路等。

2.2.3 软硬件及网络构成

简要介绍系统要求的硬件设备、支持软件及网络构成，可根据应用系统实际特点进行有所侧重的说明。

2.3 安全保密设计

应用安全内容广泛，包括权限管理机制、身份认证等；数据安全包括关键数据的加密解密，传输安全等；数据的定期备份与故障恢复等；另外如有其他方面的安全保密设计，可根据系统实际情况进行说明。

2.4 与其他外部系统的关系

简要介绍系统与其他外部系统的关系，包括系统能够为外部系统提供的服务，需要外部系统提供的服务及服务内容的简要说明。如无可空缺。

2.5 系统移植方案（备用）

介绍对系统进行数据库移植、操作系统移植等操作时的注意事项。

2.6 系统运行（备用）

简要介绍系统运行的计划周期、频度、数据量、数据增长速率、系统承受能力，并发用户数以及紧急情况的对应方法等系统运行相关内容,以及系统的升级计划和系统维护方式。

3. 系统设计

从4.1节开始编号。分节标识和描述各功能模块。

3.1 3.X 。。。（X代表子系统序号）

3.1.1 3.X.1流程

以流程图的形式描述复杂功能模块的内部实现逻辑。画流程图的目的是为了更清晰描述复杂的功能模块，因此不要求对每个功能模块都进行流程说明。如果功能模块内部还可分为子系统，且子系统的流程也较复杂，则可以按照子系统再向下分解，向下探测到每个子系统的内部实现。目的就在于将系统中复杂流程的控制逻辑描述清楚。

3.1.2 3.X.2概念级类图

建议包含概念级类图及对类图中各个类的简要说明，对类进行说明时建议至少包含类的主要属性和方法，以及各个类之间的相互关系。

3.1.3 3.X.3类与需求用例或模块之间的关系

可以表格的形式说明类图中的各个类与需求用例或模块之间的实现对应关系。

为进一步明确模块功能，可用时序图的方式对需求用例中的典型场景进行进一步描述。时序图与流程控制图不同，后者偏重于整体流程的控制，前者说明的是用例的某个场景，表明类对象之间的交互关系。

3.1.5 3.X.5数据库逻辑接口

简要说明本功能模块用到的数据库与其它功能模块之间的接口。

3.1.6 3.X.6数据库表与类之间的关系

可以表格的形式说明本模块中主要的数据库表，以及数据库表与类之间的关系。

3.1.7 3.X.7接口

简要介绍模块的接口方法、用户界面、硬件接口、软件接口等相关内容。其中接口方法能够说明本模块与其他模块之间的交互即可，在需求相对明确的前提下，尽量将接口主要参数等确定。可以使用类图的形式描述用户界面，将主要页面表示成界面类，类图能够说明界面类之间的关系即可，尽量与真正的界面流程一致。硬件接口指与其他硬件设备的接口说明，软件接口指与其他软件系统的接口说明。接口说明可视系统具体情况而定，如有其他需说明的内容，可在此处补充说明。

4. 公共设计

4.1 公共程序、基类设计

从4.1.1节开始编号。分节标识和描述各公共程序、基类。

4.1.1 4.1.X 。。。（X代表公共程序、基类序号）

4.1.1.1 4.1.X.1公用程序、基类设计

简要介绍公用程序、基类的功能，接口，属性和方法等内容。具体说明方法可参考系统设计中对各功能模块的说明。

4.1.1.2 4.1.X.2公用数据结构、数据库表设计

简要介绍公用程序、基类的数据库结构，包括主要数据库表说明，及数据库表与类之间的对应关系等内容。

4.2 异常处理、错误处理方案

要说明系统常见异常定义，通用处理方式等异常处理相关内容。

4.3 性能设计

简要介绍系统数据容量分析、性能推算等内容。