详细设计说明书.docx
- 文档编号:10720626
- 上传时间:2023-05-27
- 格式:DOCX
- 页数:7
- 大小:21.12KB
详细设计说明书.docx
《详细设计说明书.docx》由会员分享,可在线阅读,更多相关《详细设计说明书.docx(7页珍藏版)》请在冰点文库上搜索。
详细设计说明书
详细设计说明书
版本:
V2.0
文档审批修订记录
文件状态:
[]草稿
[√]正式发布
当前版本:
V2.0
作者:
郭川
审核人:
于平
发布日期:
2013-6-30
日期
版本编号
修订号
简要说明
著者
审核者
审核日期
2010-6-16
V0.5
1
新建
郭川
李永斌
2010-6-16
2010-10-28
V1.1
0
根据研发中心(架构部)建议对模板章节进行修改
李树鹏
郑明
2010-11-2
2013-6-30
V2.0
0
正式发布
李树鹏
于平
2013-6-30
说明:
“简要说明”主要是对修订原因和修订的内容进行简单说明。
目录
1引言1
1.1编写目的1
1.2适用范围1
1.3术语表1
1.4参考资料1
2产品范围1
2.1产品主要目标1
2.2主要软件需求2
2.3设计约束、限制2
3公共组件描述3
3.1组件13
3.2组件23
3.3组件n3
4应用模块设计3
4.1应用模块13
4.1.1应用功能4
4.1.2应用功能24
4.1.3应用功能N4
4.2应用模块24
4.3应用模块N4
5程序构设计5
5.1层次结构图5
5.2程序结构图5
5.3程序列表5
5.4类1(JAVA语言)/文件1(C语言)5
5.4.1方法(java)/函数(C)描述6
5.4.2代码设计6
5.5类2/文件26
5.6类N/文件N6
6数据库设计7
6.1数据库物理结构设计7
6.2数据字典说明7
1引言
1.1编写目的
本节描述编写软件产品详细设计说明书的目的。
1.2适用范围
本文档作为XXX项目在开发、测试等过程中的指导性文档,供XXX阅读。
1.3术语表
填写整个文档中涉及到的各种业务或者技术方面的术语和定义。
1.4参考资料
本节列出下列资料:
《用户需求说明书》、《需求规格说明书》、《可行性分析报告》、《概要设计说明书》等文件
客户接口说明、第三方产品说明等文件;
列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。
2产品范围
对《需求规格说明书》进行复审,如有变更需要在本节进行说明。
以下内容描述软件概要设计的整体范围,其主要信息来自于《需求规格说明书》。
2.1产品主要目标
2.2主要软件需求
2.3设计约束、限制
3公共组件描述
3.1组件1
可使用下表对每一组件进行描述。
名称
标识
接口说明
功能说明
功能函数
使用说明
3.2组件2
3.3组件n
4应用模块设计
此文档中应用模块与概要设计中应用模块相互呼应
4.1应用模块1
描述应用模块概述,可参见概要设计中应用模块概述.
4.1.1应用功能
4.1.1.1应用功能描述
4.1.1.2时序图
4.1.1.3应用功能的输入与输出
4.1.1.4异常处理
4.1.2应用功能2
4.1.3应用功能N
4.2应用模块2
4.3应用模块N
5程序构设计
5.1层次结构图
层次结构图主要描述包的层次结构(Java语言)
文件间的层次结构(C语言)
5.2程序结构图
此处主要以图形化的方式描述程序之间的关系.
针对于C语言,主要描述相关文件间的关系,以及相关函数间的关系.
针对于JAVA主要在此处以类图的方式描述类,接口等之间的关系,
.
5.3程序列表
此处主要以表格方式描述整个应用中程序列表..
针对于C语言,主要描述文件列表..
针对于JAVA主要在此处描述类以及接口列表
5.4类1(JAVA语言)/文件1(C语言)
5.4.1方法(java)/函数(C)描述
方法1:
名称
getCustQueryList
可见性
public
功能描述
查询主机资源使用情况
接口说明
参数
Map
返回值
List
外部接口
异常描述
BizException(“查询客户清单信息失败”)
备注
方法2:
名称
convertBO2BFO
可见性
public
功能描述
将BO转换成BFO
接口说明
参数
A100000BO
返回值
A100000BFO
外部接口
异常描述
备注
5.4.2代码设计
5.5类2/文件2
5.6类N/文件N
6数据库设计
6.1数据库物理结构设计
整体数据结构的物理结构图,以及相关描述
6.2数据字典说明
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 详细 设计 说明书