CMMI5文档之详细设计说明书模板docx.docx
《CMMI5文档之详细设计说明书模板docx.docx》由会员分享,可在线阅读,更多相关《CMMI5文档之详细设计说明书模板docx.docx(28页珍藏版)》请在冰豆网上搜索。
CMMI5文档之详细设计说明书模板docx
××××
详细设计说明书
文档编号:
FHI_CMMI_TS_TEM_PARD
文档信息:
详细设计说明书
文档名称:
详细设计说明书
文档类别:
CMMI模板
密级:
内部秘密
版本信息:
1.1
建立日期:
2016-1-5
创建人:
EPG
批准人:
李庆林
批准日期:
2016.2.25
存放位置:
集成公司组织资产库/组织标准过程
编辑软件:
MicrosoftOffice2003中文版
文档修订记录
(引用时请修改为实际项目的信息)
版本编号或者
变化状态
简要说明(变更内容和
修改日期
变更人
批准日期
批准人
更改记录编号
变更范围)
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
[存储过程是一种特殊的公用模块,它在数据库服务器上执行,这里将它单独列出来,规定其详细
设计模板为:
]
模板编号存储过程中文名
存储过程英文名称
功能描述[详细描述其功能]
过程算法[用形式语言详细描述其算法分析,使编程人员据此能顺利书写程序]
调用方式
参入口参数
数
出口参数
模块编写者[写上编写者姓名]
模块编写日期[写上编写日期:
yyyy/mm/dd]
模块修订者[写上修订者姓名,如果未进行修订,填写“无”]
模块修订日期[写上编写日期:
yyyy/mm/dd,如果未进行修订,填写“无”]
注意事项[实现该功能项需注意的问题]
3.3函数实现设计
3.3.1函数名称1
[函数是一种特殊的公用模块,它在数据库服务器上执行,这里将它单独列出来,规定其详细设计
模板为:
]
模板编号
函数过程中文名
函数英文名称
功能描述
[详细描述其功能]
过程算法
[用形式语言详细描述其算法分析,使编程人员据此能顺利书写程序
]
调用方式
参
入口参数
数
出口参数
模块编写者
[写上编写者姓名]
模块编写日期
[写上编写日期:
yyyy/mm/dd]
模块修订者
[写上修订者姓名,如果未进行修订,填写“无”]
模块修订日期
[写上编写日期:
yyyy/mm/dd,如果未进行修订,填写“无”
]
注意事项[实现该功能项需注意的问题]
3.4触发器实现设计
[触器也是一种公用的模,不它是式行,里将它独列出来,定其模板:
注意:
多地使用触器反而会使系的效率降低。
因此,凡是能用存程代替触器功能的地方,一律用存程来。
]
模板号
触器中文名
触器英文名称
功能描述
程算法
[描述其功能]
[用形式言描述其算法分析,使程人据此能利写程序
]
激活条件
模写者
[写上写者姓名
]
模写日期
[写上写日期:
yyyy/mm/dd]
模修者
[写上修者姓名,如果未行修,填写“无”
]
模修日期
[写上写日期:
yyyy/mm/dd
,如果未行修,填写“无”
]
注意事
[功能需注意的
]
4外部接口实现设计
4.1外部接口模块清单
[号:
DOM_[一模英文称]_{}_001
DOM_[一模英文称]_{}_002⋯⋯
其中{}中的内容可,如果在模中需要一步分模,采用{}中的内容一步模
行区分,但最多下分一,即模号最多分四段。
下表模可只写到一模,模下。
需求跟踪跟踪到叶子点,需求跟踪矩中只填写叶子点。
]
接口号
接口名称
接口英文名称
模功能述
4.2外部接口1实现设计
1.接口中文名称:
2.接口英文名称:
3.接口内容与功能:
描述接口的内容与功能,如数据或数据交。
4.接口硬件施:
描述接口的硬件施,如交机、感器或出。
5.接口件或中件:
描述接口件或中件的名称、功能、使用方法、生厂商。
6.接口的数据构:
描述接口的数据构,如文件构、数据表构。
是描述的重点之一。
7.接口的率(兆/秒):
定量明每秒最大流量。
8.接口:
定量明,如多少兆。
9.接口:
明具体。
10.接口程序的算法分析:
是重点之二,要求用形式言描述具体算法,使人据此能利写程序。
4.3外部接口2实现设计
1.接口中文名称:
2.接口英文名称:
3.接口内容与功能:
描述接口的内容与功能,如数据或数据交。
4.接口硬件施:
描述接口的硬件施,如交机、感器或出。
5.接口件或中件:
描述接口件或中件的名称、功能、使用方法、生厂商。
6.接口的数据构:
描述接口的数据构,如文件构、数据表构。
是描述的重点之一。
7.接口的率(兆/秒):
定量明每秒最大流量。
8.接口:
定量明,如多少兆。
9.接口:
明具体。
10.接口程序的算法分析:
是重点之二,要求用形式言描述具体算法,使人据此能利写程序。
5其它实现设计
本章描述前面没有明的,可参考概要明,可部角色授、界面、包装
、、数据等等。
[:
DNM_[一模英文称]_{}_001
DNM_[一模英文称]_{}_002⋯⋯
其中{}中的内容可,如果在模中需要一步分模,采用{}中的内容一步模
行区分,但最多下分一,即模号最多分四段。
下表模可只写到一模,模下。
需求跟踪跟踪到叶子点,需求跟踪矩中只填写叶子点。
]
号名称英文名称描述
5.1设计名称1
[根据需要进行设计。
]
6程序文件清单
[主要描述的内容:
各个设计对应的程序文件位置和名称,可以用列表方式一一对应列出清单,也
可以对设计与程序文件位置和命名规则进行规定说明。
根据自行制表。
]