概要设计说明书
软件项目管理-早退检讨书
2023年2月20日发(作者：场效应晶体管)##x项目概要设计说明书
〔##x模块〕
拟制日期
yyyy-mm-dd
评审人日期
批准日期
签发日期
文档修订记录
版本完成人修改内容审核批准时间
V0.00创建文档
目录
1.简介3
1.1.编写目的3
1.2.适用X围3
1.2.1.软件名称3
1.2.2.软件功能3
1.2.3.软件应用3
1.3.定义与关键词3
1.4.参考资料3
2.第0层设计描述3
2.1.软件系统上下文定义3
2.2.设计思路................................................................................................................3
2.2.1.设计可选方案3
2.2.2.设计约束4
2.2.3.其他4
2.3.系统结构4
2.3.1.系统结构描述4
2.3.2.##X模块4
3.第一层设计描述4
3.1.模块的系统结构4
3.1.1.模块内部结构4
3.1.2.业务流程说明4
3.2.分解描述5
3.2.1.##X子模块5
.
2/7
3.2.2.数据设计5
3.3.依赖性描述5
3.4.接口描述5
3.4.1.子模块1的接口描述5
4.第二层设计描述5
4.1.##X子模块5
4.1.1.子模块设计描述5
4.1.2.功能实现说明6
5.数据库设计6
5.1.实体定义6
5.1.1.分解描述6
5.1.2.内部依赖性描述6
5.2.行为定义6
5.2.1.分解描述6
5.2.2.外部依赖性描述6
5.2.3.内部依赖性描述6
6.组件视图7
6.1.系统运行组件7
6.2.文件组织形式7
7.进程视图7
表目录
表1.关键词3
图目录
图1软件架构图3
图2软件体系结构图4
图3基本包依赖关系图4
图4与其它模块关系图4
图5模块内部结构图4
图6模块结构图5
图7类##X........................................................................................................................................6
图8时序图6
.
3/7
1.简介
1.1.编写目的
这部分要描述文档的目的,并指明文档的读者.
1.2.适用X围
1.2.1.软件名称
1.2.2.软件功能
解释软件产品将完成或不完成的功能
1.2.3.软件应用
描述软件的应用领域
1.3.定义与关键词
表1.关键词
关键词英文全名中文解释
1.4.参考资料
2.第0层设计描述
2.1.软件系统上下文定义
本节描述待开发软件系统与外部实体的关系,可以使用系统结构图来描述系统结构和交互关系.
外部实体属性描述只限于描述与本系统软件设计相关的属性.
图1软件架构图
2.2.设计思路
2.2.1.设计可选方案
对本软件系统的几种设计方案进行分析、比较,并确定所采用的方案.
.
4/7
图2软件体系结构图
2.2.2.设计约束
1.遵循标准
2.硬件限制
3.技术限制
2.2.3.其他
2.3.系统结构
2.3.1.系统结构描述
这里要描述软件系统的总体结构,可以使用结构图、层次分解图或包图来描述,并应说明系统结
构划分的原则〔例如,基于标准、协议所规定的体系结构,来自于分析模型的方案,或者基于原有
体系结构的限制〕.
图3基本包依赖关系图
2.3.2.##X模块
1.简介
这里要描述本文档所设计的模块,其功能简介,与其它模块的关系.
图4与其它模块关系图
2.接口描述
本文档设计的模块与其它模块之间的接口.
3.第一层设计描述
3.1.模块的系统结构
3.1.1.模块内部结构
这里要描述本文档所设计的模块的总体结构,可以使用结构图、层次分解图或包图来描述,并应
说明结构划分的原则〔例如,基于标准、协议所规定的体系结构,来自于分析模型的方案,或者基
于原有体系结构的限制〕.
图5模块内部结构图
3.1.2.业务流程说明
描述该模块用例模型中的典型用例场景,以体现其功能是如何实现的.建议采用Sequence图、
Collaboration图等来描述.
.
5/7
3.2.分解描述
3.2.1.##X子模块
1.简介
2.功能列表
3.2.2.数据设计
本节描述本文档所设计的模块中的数据结构,外部数据实体不必描述.
1.数据实体1描述
1)标识：
2)类型：
3)目的：
3.3.依赖性描述
本节描述本文档所设计的模块的子系统,数据结构,模块,进程等设计实体间的关系.依赖关系描
述可以使用文字,结构图,〔交互〕事务图.
3.4.接口描述
3.4.1.子模块1的接口描述
该子模块与其它子模块之间的接口描述.
名称：接口名称
说明：对接口的简短说明
定义：接口原型定义,说明接口类型与相关参数
4.第二层设计描述
4.1.##X子模块
4.1.1.子模块设计描述
描述子模块的功能定义.定义出具体的设计类,用类图来描述其相互关系,并说明所采用的设计模
式.
图6模块结构图
1.类名##X
1)标识
说明该类的配置项标识
.
6/7
2)简介
简单介绍该类的功能
3)类定义
如果该类在前面没有定义,使用类图、伪代码描述该类的类定义,需说明该类的所有public属性
和public方法.
图7类##X
4.1.2.功能实现说明
1.##X功能
图8时序图
5.数据库设计
本节列出所有的数据存储类的实体,详细描述实体的内容和并列出
全部属性.对每个属性,详细描述其数据库、数据大小、特定约束.实体的所有约束与实体间的关
系也要注明.
5.1.实体定义
5.1.1.分解描述
阐述设计思路与约束规则.详细定义每个关键数据表、视图中的各个字段属性、存储要求、完整
性约束、功能、注意事项,对静态数据表应考虑定义初始配置记录.
5.1.2.内部依赖性描述
使用E-R图描述实体间的关联依赖关系,分析对存取空间、性能、完整性的要求.
5.2.行为定义
5.2.1.分解描述
根据功能或其他方式对存储过程/触发器进行归类,便于进一步细化和分解,并说明每类存储过程
/触发器主要功能.
详细定义每个存储过程的功能、输入输出参数、返回值、返回的记录集、依赖的数据
表和存储过程,以与一些特殊要求〔比如需要启用事务等〕.
5.2.2.外部依赖性描述
描述与其它模块之间的依赖关系.
5.2.3.内部依赖性描述
描述存储过程间、存储过程和数据表/视图间依赖关系.
.
7/7
6.组件视图
6.1.系统运行组件
使用Component图、deployment图来描述系统的运行组件〔EXE文件、DLL等〕,与其网络
部署情况.
6.2.文件组织形式
描述源代码文件的目录结构〔文件夹中各个目录下应存放什么文件〕
7.进程视图
本节描述将系统分解为轻量级进程〔单个控制线程〕和重量级进程〔成组的轻量级进程〕的过
程.本节按照各个通信或交互的进程组来加以组织.说明进程之间的主要通信模式,例如消息传
递、中断和会合.