软件概要设计说明书.docx

XXX项目概要设计说明书
（XXX模块）
拟制 评审人 批准 签发
日期 yyyy-mm-dd
日期
日期
日期
文档修订记录
版本
完***
修改内容
审核
批准
时间

创建文档
目录
简介 5
编写目的 5
适用范围 5
软件名称 5
软件功能 5
软件应用 5
定义及关键词 5
参考资料 5
第 0 层设计描述 6
软件系统上下文定义 6
设计思路 （可选） 6
设计可选方案 6
设计约束 6
其他 6
系统结构 6
系统结构描述 6
XXX 模块 6
第一层设计描述 8
模块的系统结构 8
模块内部结构 8
业务流程说明 8
分解描述 8
XXX 子模块 8
数据设计 8
依赖性描述 8
接口描述 9
子模块 1 的接口描述 9
第二层设计描述 10
XXX 子模块 10
子模块设计描述 10
功能实现说明 10
数据库设计 11
实体定义 11
分解描述 11
内部依赖性描述 11
行为定义 11
分解描述 11
外部依赖性描述 11
内部依赖性描述 11
组件视图 12
系统运行组件 12
文件组织形式 12
进程视图 12
表目录
表 1. 关键词 5
图目录
图 1 软件架构图 6
图 2 软件体系结构图 6
图 3 基本包依赖关系图 6
图 4 与其它模块关系图 7
图 5 模块内部结构图 8
图 6 模块结构图 10
图7 类 XXX 10
图 8 时序图 10
简介
编写目的
这部分要描述文档的目的，并指明文档的读者。
适用范围
软件名称

解释软件产品将完成或不完成的功能
软件应用
描述软件的应用领域
定义及关键词

关键词
英文全名
中文解释
参考资料
[1]
第 0 层设计描述
软件系统上下文定义 本节描述待开发软件系统与外部实体的关系，可以使用系统结构图来描述系统结构和交互关 系。外部实体属性描述只限于描述与本系统软件设计相关的属性。
图1 软件架构图
设计思路 （可选 ）
设计可选方案
对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案。
图 2 软件体系结构图
设计约束
遵循标准
硬件限制
技术限制
其他
系统结构
系统结构描述
这里要描述软件系统的总体结构，可以使用结构图、层次分解图或包图来描述，并应说明系统 结构划分的原则（例如，基于标准、协议所规定的体系结构，来自于分析模型的方案，或者基 于原有体系结构的限制）。
图 3 基本包依赖关系图
XXX 模块
1. 简介
这里要描述本文档所设计的模块，其功能简介，与其它模块的关系。
图 4 与其它模块关系图
2. 接口描述
本文档设计的模块与其它模块之间的接口。
第一层设计描述
模块的系统结构
模块内部结构 这里要描述本文档所设计的模块的总体结构，可以使用结构图、层次分解图或包图来描述，并 应说明结构划分的原则（例如，基于标准、协议所规定的体系结构，来自于分析模型的方案， 或者基于原有体系结构的限制）。
图 5 模块内部结构图
业务流程说明
描述该模块用例模型中的典型用例场景， 以体现其功能是如何实现的。 建议采用 Sequence 图、 Collaboration 图等来描述。
分解描述
XXX 子模块
1. 简介
2. 功能列表
数据设计
本节描述本文档所设计的模块中的数据结构，外部数据实体不必描述。
1. 数据实体 1 描述
1） 标识：
2） 类型：
3） 目的：
依赖性描述
本节描述本文档所设计的模块的子系统，数据结构，模块，进程等设计实体间的关系。依赖关 系描述可以使用文字，结构图，（交互）事务图。
接口描述
子模块 1 的接口描述
该子模块与其它子模块之间的接口描述。
名称：
接口名称
说明：
对接口的简短说明
定义：
接口原型定义，说明接口类型及相关参数
第二层设计描述
XXX 子模块
子模块设计描述
描述子模块的功能定义。定义出具体的设计类，用类图来描述其相互关系，并说明所采用的设