概要设计说明书模板.docx
《概要设计说明书模板.docx》由会员分享，可在线阅读，更多相关《概要设计说明书模板.docx（6页珍藏版）》请在冰豆网上搜索。
概要设计说明书模板
[键入文档副标题]
XX项目
概要设计说明书
上海恒志软件科技有限公司
修改记录
版本
日期
修改人
修改内容
V0.1
2009-10-26
武勇
建立初稿。
目录
1概述1
1.1编写目的1
1.2阅读范围1
1.3名词定义1
1.4参考资料1
2总体设计2
2.1系统拓扑图2
2.1.1系统运行环境说明2
2.2开发工具/公用框架描述2
2.3系统功能结构图/系统模块划分图2
2.3.1功能需求和系统模块映射矩阵2
2.3.2系统模块部署关系3
2.4数据流图及说明3
2.5系统目录结构3
3接口设计5
3.1外部接口5
3.2内部接口5
3.2.1接口列表5
3.2.2接口描述5
3.2.2.1接口名称15
4数据模型7
4.1域对象模型关系7
4.2表结构设计7
5系统出错处理设计8
5.1出错信息8
5.2错误显示方式8
5.3异常和错误在程序中的处理方式8
6参考资料9
1概述
1.1编写目的
1.2阅读范围
1.3名词定义
1.4参考资料
2总体设计
2.1系统拓扑图
概述系统网络拓朴结构。
2.1.1系统运行环境说明
列出运行该软件所需要的硬设备。
说明其中的新型设备及其专门功能。
列出支持软件，包括要用到的操作系统、编译（或汇编）程序、测试支持软件等。
说明该系统同其他系统之间的接口、数据通信协议等。
2.2开发工具/公用框架描述
概述系统运行软/硬件开发环境与开发工具。
以及采用的本公司开发公用框架、类库，开源软件，以及相应的版本。
2.3系统层次架构图
给出系统设置的层次结构，例如：
两层、三层、或多层结构之间的调用关系，组件名称等。
2.4系统功能结构图/系统模块划分图
给出系统结构总体框图，说明本系统的各模块的划分，扼要说明每个系统模块的标识符和功能，给出各模块之间的控制与被控制关系。
2.4.1功能需求和系统模块映射矩阵
功能需求与系统模块的关系
本条用一张矩阵图说明各项功能需求的实现同各模块的分配关系。
[系统模块1]
[系统模块2]
[……]
[系统模块m]
[功能需求1]
√
[功能需求2]
√
[┇]
[功能需求n]
√
2.4.2系统模块部署关系
功能模块（组件）部属表
功能模块（组件）
服务器
2.5数据流图及说明
描述系统内部模块、子系统及外部系统之间数据流转、生命周期。
2.6系统目录结构
描述本系统开发的目录基本命名规范。
模块
路径
模块名称
说明
域对象模型
系统域对象模型，包括流程框架使用的域对象模型
Struts配置文件和Action
各专业的struts配置以及strutsaction实现类
业务方法
系统业务方法，包括流程框架的业务方法
Web模块源码
/
Task
task/jh
task/cs
任务单页面jsp
Requirement
需求单页面jsp
Frame
页面框架的jsp和Html
scripts
系统使用的样式表和js
Images
系统的图片
Js
Brick框架代码
3接口设计
3.1外部接口
说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持系统之间的接口关系。
可以是一个简单表格，表述本系统所有接口列表，并指明接口设计文档名称。
序号
接口名称
外部系统名称
主要技术
备注
如果外部接口是在单独文档中描述，请说明参考文档名称。
3.2内部接口
说明本系统之内的各个系统元素之间的接口的安排。
3.2.1接口列表
序号
接口名称
接口涉及模块名称
备注
3.2.2接口描述
3.2.2.1接口名称1
4数据模型
4.1域对象模型关系
可说明指向某具体数据模型设计文档。
4.2表结构设计
可说明指向某具体数据模型设计文档。
5系统出错处理设计
5.1错误类型及输入方式
应说明本系统中异常的显示具体方式：
页面报错，后台日志，对话框等。
例如：
出错信息
输出形式
处理方法
业务方法出现异常
日志文件
例如，主要的异常类，异常的抛出、异常信息的设置，异常和错误处理的层次等内容。
客户端出现异常
客户端：
页面报错/对话框
后台：
日志文件
5.2出错信息一览表
用一览表的方式说明每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。
也可以用独立的文档另外给出。
升级会员 