CMMI5文档之详细设计说明书模板
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
××××
详细设计说明书
文档编号:FHI_CMMI_TS_TEM_PARD
文档信息:详细设计说明书
文档名称:详细设计说明书
文档类别:CMMI模板
密级:内部秘密
版本信息:1.1
建立日期:2016-1-5
创建人:EPG
批准人:李庆林
批准日期:2016.2.25
存放位置:集成公司组织资产库/组织标准过程
编辑软件:Microsoft Office 2003 中文版
文档修订记录(引用时请修改为实际项目的信息)版本编号或者
更改记录编号变化状态
简要说明(变更内容和
变更范围)
修改日期变更人批准日期批准人
V1.0 C 创建2016-1-5 张娜娜2016-2-25
李庆林V1.0 M 文档编号去掉版本号2016-4-17 邓沛沛2016-4-17 李庆林
*变化状态:C――创建,A——增加,M——修改,D——删除
目录
1导言 (4)
1.1目的 (4)
1.2范围 (4)
1.3术语定义 (4)
1.4相关文档 (4)
1.5参考资料 (4)
2功能模块实现设计 (5)
2.1功能模块清单 (5)
2.2一级功能模块名称 (5)
2.2.1二级功能模块名称 (5)
3数据库实现设计 (6)
3.1数据库模块清单 (6)
3.2存储过程实现设计 (6)
3.2.1存储过程名称 1 (6)
3.3函数实现设计 (7)
3.3.1函数名称1 (7)
3.4触发器实现设计 (8)
4外部接口实现设计 (8)
4.1外部接口模块清单 (8)
4.2外部接口1实现设计 (8)
4.3外部接口2实现设计 (9)
5其它实现设计 (9)
5.1详细设计名称 1 (10)
6程序文件清单 (10)
1导言
[本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。]
1.1目的
[本文档的目的旨在推动软件工程的规范化,使设计人员遵循统一的详细设计书写规范,节省制作
文档的时间,降低系统实现的风险,做到系统设计资料的规范性与全面性,以利于系统的实现、测试、
维护、版本升级等。
详细设计的详细程度,应达到可以编写程序的水平。[
1.2范围
[本文档用于软件设计阶段的详细设计,它的上游(依据的基线)是概要设计说明书,它的下游是
源程序清单及单元测试计划,并为单元测试报告提供测试依据。
软件详细设计的范围是:各功能模块实现设计、数据库实现设计。[
1.3术语定义
序号术语名称术语定义
1 详细设计在概要设计的基础上,对其功能模块或部件进行实现设计,使编程人
员据此能顺利书写出程序代码。
2 存储过程存放在数据库服务器上的一段程序,它能被其它程序调用,以完成对
数据库表的某些规定操作。
3 触发器存放在数据库服务器上的一段程序,当触发条件满足时它就被执行,
以完成对数据库表的某些规定操作。
1.4相关文档
1.源程序清单
2.单元测试计划及报告
3.用户使用手册
1.5参考资料
1.软件需求规格说明书
2.概要设计说明书
3.软件合同
4.命名规范
2功能模块实现设计
[详细设计是面向模块的,或者说是面向部件(组件或构件)的,不是面向组织结构或部门单位的。
一个组织或单位,根据角色的授权,可以挂上某些功能模块。]
2.1功能模块清单
[编码规则:
DM_[一级模块英文简称]_{}_001
DM_[一级模块英文简称]_{}_002……
其中{}中的内容为可选项,如果在模块中还需要进一步细分模块,则采用{}中的内容进一步对模块
进行区分,但最多下分一级,即模块编号最多分四段。
下表模块可只写到一级模块,详细模块见下。需求跟踪时跟踪到叶子节点,需求跟踪矩阵中只填写叶子节点。]
模块编号模块名称模块英文名称模块功能简述模块的接口说明
2.2一级功能模块名称
2.2.1二级功能模块名称
模块编号DM_XXX_001 模块名称
英文名称
功能描述
接口标准提供调用
背景描述[对背景进行简单的描述。为什么需要此模块功能,其上下文环境。涉及业务背景内容,与需求相结合。]
模块提供
接口描述
[详细列出提供的接口方法、入口参数、出口参数、异常处理(针对公用方法)] 相关表[说明引用的主要业务表,说明对表所进行的操作(读/写)]
模块算法
设计
[描述具体的操作步骤。描述操作步骤,简单的说明书内容。可以采用图形交互。] 模块编写
者
[写上编写者姓名]
模块编写
[写上编写日期:yyyy/mm/dd]
日期
模块修订
[写上修订者姓名,如果未进行修订,填写“无”]
者
模块修订
[写上编写日期:yyyy/mm/dd,如果未进行修订,填写“无”]
日期
注意事项[实现该功能项需注意的问题]
3数据库实现设计
3.1数据库模块清单
[编号规则:存储过程(procedure),以DP开头:
DP_{}_001、DP_{}_002
函数(function),以DF开头:
DF_{}_001、DF_{}_002
触发器(trigger),以DT开头:
DT_{}_001、DT_{}_002
其中{}中的内容为可选项,如果在模块中还需要进一步细分模块,则采用{}中的内容进一步对模块进行区分,但最多下分一级,即模块编号最多分四段。
下表模块可只写到一级模块,详细模块见下。需求跟踪时跟踪到叶子节点,需求跟踪矩阵中只填写叶子节点。]
模块编号模块名称模块英文名称模块功能简述
3.2存储过程实现设计
3.2.1存储过程名称 1
[存储过程是一种特殊的公用模块,它在数据库服务器上执行,这里将它单独列出来,规定其详细
设计模板为:]
模板编号存储过程中文名
存储过程英文名称
功能描述[详细描述其功能]
过程算法[用形式语言详细描述其算法分析,使编程人员据此能顺利书写程序]
调用方式