软件概要设计说明书

-

xxx项目概要设计说明书

（xxx模块）

拟制日期yyyy-mm-dd 评审人日期

批准日期

签发日期

文档修订记录

目录

1. 简介3

1.1. 编写目的3

1.2. 适用范围3

1.2.1. 软件名称3

1.2.2. 软件功能3

1.2.3. 软件应用4

1.3. 定义及关键词4

1.4. 参考资料4

2. 第0层设计描述4

2.1. 软件系统上下文定义4

2.2. 设计思路(可选) (4)

2.2.1. 设计可选方案4

2.2.2. 设计约束5

2.2.

3. 其他5

2.3. 系统结构5

2.3.1. 系统结构描述5

2.3.2. XXX模块5

3. 第一层设计描述6

3.1. 模块的系统结构6

3.1.1. 模块内部结构6

3.1.2. 业务流程说明6

3.2. 分解描述6

3.2.1. XXX子模块6

3.2.2. 数据设计6

3.3. 依赖性描述7

3.4. 接口描述7

3.4.1. 子模块1的接口描述7

4. 第二层设计描述7

4.1. XXX子模块7

4.1.1. 子模块设计描述7

4.1.2. 功能实现说明8

5. 数据库设计8

5.1. 实体定义8

5.1.1. 分解描述8

5.1.2. 内部依赖性描述8

5.2. 行为定义8

5.2.1. 分解描述8

5.2.2. 外部依赖性描述8

5.2.3. 内部依赖性描述9

6. 组件视图9

6.1. 系统运行组件9

6.2. 文件组织形式9

7. 进程视图9

表目录

表1.关键词4

图目录

图1软件架构图4

图2软件体系结构图5

图3基本包依赖关系图5

图4与其它模块关系图5

图5模块内部结构图6

图6模块结构图7

图7类XXX (8)

图8时序图8

1.简介

1.1. 编写目的

这部分要描述文档的目的，并指明文档的读者。

1.2. 适用范围

1.2.1. 软件名称

1.2.2. 软件功能

解释软件产品将完成或不完成的功能

1.2.3. 软件应用

描述软件的应用领域

1.3. 定义及关键词

表1.关键词

1.4. 参考资料

[1]

2.第0层设计描述

2.1. 软件系统上下文定义

本节描述待开发软件系统与外部实体的关系，可以使用系统结构图来描述系统结构和交互关系。外部实体属性描述只限于描述与本系统软件设计相关的属性。

图1软件架构图

2.2. 设计思路(可选)

2.2.1. 设计可选方案

对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案。

图2软件体系结构图

2.2.2. 设计约束

1. 遵循标准

2. 硬件限制

3. 技术限制

2.2.

3. 其他

2.3. 系统结构

2.3.1. 系统结构描述

这里要描述软件系统的总体结构，可以使用结构图、层次分解图或包图来描述，并应说明系统结构划分的原则（例如，基于标准、协议所规定的体系结构，来自于分析模型的方案，或者基于原有体系结构的限制）。

图3基本包依赖关系图

2.3.2. XXX模块

1. 简介

这里要描述本文档所设计的模块，其功能简介，与其它模块的关系。

图4与其它模块关系图

2. 接口描述

本文档设计的模块与其它模块之间的接口。

3.第一层设计描述

3.1. 模块的系统结构

3.1.1. 模块内部结构

这里要描述本文档所设计的模块的总体结构，可以使用结构图、层次分解图或包图来描述，并应说明结构划分的原则（例如，基于标准、协议所规定的体系结构，来自于分析模型的方案，或者基于原有体系结构的限制）。

图5模块内部结构图

3.1.2. 业务流程说明

描述该模块用例模型中的典型用例场景，以体现其功能是如何实现的。建议采用Sequence图、Collaboration图等来描述。

3.2. 分解描述

3.2.1. XXX子模块

1. 简介

2. 功能列表

3.2.2. 数据设计

本节描述本文档所设计的模块中的数据结构，外部数据实体不必描述。

1. 数据实体1描述

1)标识：

2)类型：

3)目的：

3.3. 依赖性描述

本节描述本文档所设计的模块的子系统，数据结构，模块，进程等设计实体间的关系。依赖关系描述可以使用文字，结构图，（交互）事务图。

3.4. 接口描述

3.4.1. 子模块1的接口描述

该子模块与其它子模块之间的接口描述。

名称：接口名称

说明：对接口的简短说明

定义：接口原型定义，说明接口类型及相关参数

4.第二层设计描述

4.1. XXX子模块

4.1.1. 子模块设计描述

描述子模块的功能定义。定义出具体的设计类，用类图来描述其相互关系，并说明所采用的设计模式。

图6模块结构图

1. 类名XXX

1)标识

说明该类的配置项标识(用于需求跟踪，配置项的命名方式在CMP中已定义)

2)简介

简单介绍该类的功能

3)类定义

如果该类在前面没有定义，使用类图、伪代码描述该类的类定义，需说明该类的所有public属性和public方法。