软件概要设计说明书.doc

xxx项目概要设计说明书
（xxx模块）

拟制

日期
yyyy-mm-dd
评审人

日期

批准

日期

签发

日期

文档修订记录

版本
完毕人
修改内容
审核
批准
时间
V0.00

创建文档

目 录
1. 简介 5
1.1. 编写目的 5
1.2. 合用范围 5
1.2.1. 软件名称 5
1.2.2. 软件功能 5
1.2.3. 软件应用 5
1.3. 定义及关键词 5
1.4. 参考资料 5
2. 第0层设计描述 6
2.1. 软件系统上下文定义 6
2.2. 设计思绪(可选) 6
2.2.1. 设计可选方案 6
2.2.2. 设计约束 6
2.2.3. 其他 6
2.3. 系统结构 6
2.3.1. 系统结构描述 6
2.3.2. XXX模块 6
3. 第一层设计描述 8
3.1. 模块的系统结构 8
3.1.1. 模块内部结构 8
3.1.2. 业务流程说明 8
3.2. 分解描述 8
3.2.1. XXX子模块 8
3.2.2. 数据设计 8
3.3. 依赖性描述 8
3.4. 接口描述 9
3.4.1. 子模块1的接口描述 9
4. 第二层设计描述 10
4.1. XXX子模块 10
4.1.1. 子模块设计描述 10
4.1.2. 功能实现说明 10
5. 数据库设计 11
5.1. 实体定义 11
5.1.1. 分解描述 11
5.1.2. 内部依赖性描述 11
5.2. 行为定义 11
5.2.1. 分解描述 11
5.2.2. 外部依赖性描述 11
5.2.3. 内部依赖性描述 11
6. 组件视图 12
6.1. 系统运营组件 12
6.2. 文献组织形式 12
7. 进程视图 12

表目录
表1. 关键词 5
图目录
图1 软件架构图 6
图2 软件体系结构图 6
图3 基本包依赖关系图 6
图4 与其它模块关系图 7
图5 模块内部结构图 8
图6 模块结构图 10
图7 类XXX 10
图8 时序图 10

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方法。

图7 类XXX
4.1.2. 功能实现说明
1. XXX功能

图8 时序图

5. 数据库设计
本节列出所有的数据存储类的实体(表、存储过程、触发器等)，具体描述实体的内容和并列出所有属性。对每个属性，具体描述其数据库、数据大小、特定约束。实体的所有约束及实体间的关系也要注明。
5.1. 实体定义
5.1.1. 分解描述
阐述设计思绪及约束规则。具体定义每个关键数据表、视图中的各个字段属性、存储规定、完整性约束、功能、注意事项，对静态数据表应考虑定义初始配置记录。
5.1.2. 内部依赖性描述
使用E-R图描述实体间的关联依赖关系，分析对存取空间、性能、完整性的规定。

5.2. 行为定义
5.2.1. 分解描述
根据功能或其他方式对存储过程/触发器进行归类，便于进一步细化和分解，并说明每类存储过程/触发器重要功能。
具体定义每个存储过程(触发器)的功能、输入输出参数、返回值、返回的记录集、依赖的数据表和存储过程，以及一些特殊规定（比如需要启用事务等）。
5.2.2. 外部依赖性描述
描述与其它模块之间的依赖关系。
5.2.3. 内部依赖性描述
描述存储过程间、存储过程和数据表/视图间依赖关系。
6. 组件视图
6.1. 系统运营组件
使用Component图、deployment图来描述系统的运营组件（EXE文献、DLL等），及其网络部署情况。
6.2. 文献组织形式
描述源代码文献的目录结构（文献夹中各个目录下应存放什么文献）
7. 进程视图
本节描述将系统分解为轻量级进程（单个控制线程）和重量级进程（成组的轻量级进程）的过程。本节按照各个通信或交互的进程组来加以组织。说明进程之间的重要通信模式，例如消息传递、中断和会合。