软件概要设计说明书

概要设计说明书第12页共12页xxx项目概要设计说明书（xxx模块）拟制日期yyyy-mm-dd评审人日期批准日期签发日期

文档修订记录版本完成人修改内容审核批准时间V0.00创建文档

目录TOC\o"1-3"\u1.简介 51.1.编写目的 51.2.适用范围 51.2.1.软件名称 51.2.2.软件功能 51.2.3.软件应用 51.3.定义及关键词 51.4.参考资料 52.第0层设计描述 62.1.软件系统上下文定义 62.2.设计思路(可选) 62.2.1.设计可选方案 62.2.2.设计约束 62.2.3.其他 62.3.系统结构 62.3.1.系统结构描述 62.3.2.XXX模块 63.第一层设计描述 83.1.模块的系统结构 83.1.1.模块内部结构 83.1.2.业务流程说明 83.2.分解描述 83.2.1.XXX子模块 83.2.2.数据设计 83.3.依赖性描述 83.4.接口描述 93.4.1.子模块1的接口描述 94.第二层设计描述 104.1.XXX子模块 104.1.1.子模块设计描述 104.1.2.功能实现说明 105.数据库设计 115.1.实体定义 115.1.1.分解描述 115.1.2.内部依赖性描述 115.2.行为定义 115.2.1.分解描述 115.2.2.外部依赖性描述 115.2.3.内部依赖性描述 116.组件视图 126.1.系统运行组件 126.2.文件组织形式 127.进程视图 12表目录TOC\t"表号去除自动编号,1,表号,1,tabledescription,1"表1. 关键词 5图目录TOC\t"图号去除自动编号,1,图号,1,figuredescription,1"图1 软件架构图 6图2 软件体系结构图 6图3 基本包依赖关系图 6图4 与其它模块关系图 7图5 模块内部结构图 8图6 模块结构图 10图7 类XXX 10图8 时序图 10

简介编写目的这部分要描述文档的目的，并指明文档的读者。适用范围软件名称软件功能解释软件产品将完成或不完成的功能软件应用描述软件的应用领域定义及关键词关键词关键词英文全名中文解释参考资料

第0层设计描述软件系统上下文定义本节描述待开发软件系统与外部实体的关系，可以使用系统结构图来描述系统结构和交互关系。外部实体属性描述只限于描述与本系统软件设计相关的属性。软件架构图设计思路(可选)设计可选方案对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案。软件体系结构图设计约束遵循标准硬件限制技术限制其他系统结构系统结构描述这里要描述软件系统的总体结构，可以使用结构图、层次分解图或包图来描述，并应说明系统结构划分的原则（例如，基于标准、协议所规定的体系结构，来自于分析模型的方案，或者基于原有体系结构的限制）。基本包依赖关系图XXX模块简介这里要描述本文档所设计的模块，其功能简介，与其它模块的关系。与其它模块关系图接口描述本文档设计的模块与其它模块之间的接口。

第一层设计描述模块的系统结构模块内部结构这里要描述本文档所设计的模块的总体结构，可以使用结构图、层次分解图或包图来描述，并应说明结构划分的原则（例如，基于标准、协议所规定的体系结构，来自于分析模型的方案，或者基于原有体系结构的限制）。模块内部结构图业务流程说明描述该模块用例模型中的典型用例场景，以体现其功能是如何实现的。建议采用Sequence图、Collaboration图等来描述。分解描述XXX子模块简介功能列表数据设计本节描述本文档所设计的模块中的数据结构，外部数据实体不必描述。数据实体1描述标识：类型：目的：依赖性描述本节描述本文档所设计的模块的子系统，数据结构，模块，进程等设计实体间的关系。依赖关系描述可以使用文字，结构图，（交互）事务图。接口描述子模块1的接口描述该子模块与其它子模块之间的接口描述。名称：接口名称说明：对接口的简短说明定义：接口原型定义，说明接口类型及相关参数

第二层设计描述XXX子模块子模块设计描述描述子模块的功能定义。定义出具体的设计类，用类图来描述其相互关系，并说明所采用的设计模式。模块结构图类名XXX标识说明该类的配置项标识(用于需求跟踪，配置项的命名方式在CMP中已定义)简介简单介绍该类的功能类定义如果该类在前面没有定义，使用类图、伪代码描述该类的类定义，需说明该类的所有public属性和public方法。类XXX功能实现说明XXX功能时序图

数据库设计本节列出所有的数据存储类的实体(表、存储过程、触发器等)，详细描述实体的内容和并列出全部属性。对每个属性，详细描述其数据库、数据大小、特定约束。实体的所有约束及实体间的关系也要注明。实体定义分解描述阐述设计思路及约束规则。详细定义每个关键数据表、视图中的各个字段属性、存储要求、完整性约束、功能、注意事项，对静态数据表应考虑定义初始配置记录。内部依赖性描述使用E-R图描述实体间的关联依赖关系，分析对存取空间、性能、完整性的要求。行为定义分解描述根据功能或其他方式对存储过程/触发器进行归类，便于进一步细化和分解，并说明每类存储过程/触发器主要功能。详细定义每个存储过程(触发器)的功能、输入输出参数、返回值、返回的记录集、依赖的数据表和存储过程，以及一些特殊要求（比如需要启用事务等）。外部依赖性描述描述与其它模块之间的依赖关系。内部依赖性描述描述存储过程间、存储过程和数据表/视图间依赖关系。

组