xxx项目概要设计说明书(xxx模块)拟制日期yyyy-mm-dd 评审人日期批准日期签发日期文档修订记录目录1. 简介错误!未定义书签。
. 编写目的...................................................... 错误!未定义书签。
. 适用范围...................................................... 错误!未定义书签。
软件名称 .................................................. 错误!未定义书签。
软件功能 .................................................. 错误!未定义书签。
软件应用 .................................................. 错误!未定义书签。
. 定义及关键词.................................................. 错误!未定义书签。
. 参考资料...................................................... 错误!未定义书签。
2. 第0层设计描述 ................................................... 错误!未定义书签。
. 软件系统上下文定义............................................ 错误!未定义书签。
. 设计思路(可选) ................................................ 错误!未定义书签。
设计可选方案 .............................................. 错误!未定义书签。
设计约束 .................................................. 错误!未定义书签。
其他 ...................................................... 错误!未定义书签。
. 系统结构...................................................... 错误!未定义书签。
系统结构描述 .............................................. 错误!未定义书签。
XXX模块................................................... 错误!未定义书签。
3. 第一层设计描述 ................................................... 错误!未定义书签。
. 模块的系统结构................................................ 错误!未定义书签。
模块内部结构 .............................................. 错误!未定义书签。
业务流程说明 .............................................. 错误!未定义书签。
. 分解描述...................................................... 错误!未定义书签。
XXX子模块................................................. 错误!未定义书签。
数据设计 .................................................. 错误!未定义书签。
. 依赖性描述.................................................... 错误!未定义书签。
. 接口描述...................................................... 错误!未定义书签。
子模块1的接口描述 ........................................ 错误!未定义书签。
4. 第二层设计描述 ................................................... 错误!未定义书签。
. XXX子模块 .................................................... 错误!未定义书签。
子模块设计描述 ............................................ 错误!未定义书签。
功能实现说明 .............................................. 错误!未定义书签。
5. 数据库设计 ....................................................... 错误!未定义书签。
. 实体定义...................................................... 错误!未定义书签。
分解描述 .................................................. 错误!未定义书签。
内部依赖性描述 ............................................ 错误!未定义书签。
. 行为定义...................................................... 错误!未定义书签。
分解描述 .................................................. 错误!未定义书签。
外部依赖性描述 ............................................ 错误!未定义书签。
内部依赖性描述 ............................................ 错误!未定义书签。
6. 组件视图 ......................................................... 错误!未定义书签。
. 系统运行组件.................................................. 错误!未定义书签。
. 文件组织形式.................................................. 错误!未定义书签。
7. 进程视图 ......................................................... 错误!未定义书签。
表目录表1. 关键词 ...................................................... 错误!未定义书签。
图目录图1 软件架构图 .................................................. 错误!未定义书签。
图2 软件体系结构图............................................... 错误!未定义书签。
图3 基本包依赖关系图............................................. 错误!未定义书签。
图4 与其它模块关系图............................................. 错误!未定义书签。
图5 模块内部结构图............................................... 错误!未定义书签。
图6 模块结构图 .................................................. 错误!未定义书签。
图7 类XXX ....................................................... 错误!未定义书签。
图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.依赖性描述本节描述本文档所设计的模块的子系统,数据结构,模块,进程等设计实体间的关系。