CMMI5文档之详细设计说明书模板

详细设计说明书文档编号：FHI_CMMI_TS_TEM_PARD文档信息 ：详细设计说明书文档名称 ：详细设计说明书文档类别 ：CMMI 模板密级：内部秘密版本信息 ：1.1建立日期 ：2016-1-5创建人：EPG批准人：李庆林批准日期：2016.2.25存放位置：集成公司组织资产库 /组织标准过程编辑软件：MicrosoftOffice2003中文版文档修订记录（引用时请修改为实际项目的信息）版本编号或者更改记录编勺变化状态简要说明（变更内容和变更范围）修改日期变更人批准日期批准人V1.0C创建2016-1-5张娜娜2016-2-25李庆林V1.0M文档编号去掉版本号2016-4-17邓沛沛2016-4-17李庆林*变化状态：C创建，A——增加，M修改，D一—删除TOC\o"1-5"\h\z\o"CurrentDocument"导言 4\o"CurrentDocument"目的 4\o"CurrentDocument"范围 4\o"CurrentDocument"术语定义 4\o"CurrentDocument"相关文档 4\o"CurrentDocument"参考资料 4\o"CurrentDocument"功能模块实现设计 5\o"CurrentDocument"功能模块清单 5一级功能模块名称 5二级功能模块名称 5数据库实现设计 6数据库模块清单 6存储过程实现设计 6存储过程名称 1 6函数实现设计 7函数名称1 7\o"CurrentDocument"触发器实现设计 8\o"CurrentDocument"外部接口实现设计 8外部接口模块清单 8\o"CurrentDocument"外部接口 1实现设计 8外部接口 2实现设计 9\o"CurrentDocument"其它实现设计 9详细设计名称 1 10\o"CurrentDocument"程序文件清单 101导言[本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。 ]目的[本文档的目的旨在推动软件工程的规范化，使设计人员遵循统一的详细设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。详细设计的详细程度，应达到可以编写程序的水平。 [范围[本文档用于软件设计阶段的详细设计，它的上游（依据的基线）是概要设计说明书，它的下游是源程序清单及单元测试计划，并为单元测试报告提供测试依据。软件详细设计的范围是：各功能模块实现设计、数据库实现设计。 [术语定义序号术语名称术语定义1详细设计在概要设计的基础上，对其功能模块或部件进行实现设计， 使编程人员据此能顺利书写出程序代码。2存储过程存放在数据库服务器上的一段程序， 它能被其它程序调用，以完成对数据库表的某些规定操作。3触发器存放在数据库服务器上的一段程序，当触发条件满足时它就被执行，以完成对数据库表的某些规定操作。相关文档源程序清单单元测试计划及报告用户使用手册参考资料软件需求规格说明书概要设计说明书软件合同命名规范功能模块实现设计［详细设计是面向模块的，或者说是面向部件（组件或构件）的，不是面向组织结构或部门单位的。一个组织或单位，根据角色的授权，可以挂上某些功能模块。 ］功能模块清单［编码规则：DM_［一级模块英文简称］_{}_001DM_［一级模块英文简称］_{}_002……其审{}中的内容为可选项，加果在模块中还需要进一步细分模块， 则采用{}中的内容进一步对模块进行区分，但最多下分一级，即模块编号最多分四段。下表模块可只写到一级模块， 详细模块见下。需求跟踪时跟踪到叶子节点， 需求跟踪矩阵中只填写叶子节点。］模块编号模块名称模块英文名称模块功能简述模块的接口说明一级功能模块名称二级功能模块名称模块编号DM_XXX_001 模块名称央文名称功能描述接口标准提供调用背景描述［对背景进行简单的描述。为什么需要此模块功能，其上下文环境。涉及业务背景内合，T向求相结口。 ］模块提供接口描述［详细列出提供的接口方法、入口参数、出口参数、异常处理（针对公用方法） ］相关表［说明引用的主要业务表，说明对表所进行的操作（读 /写）］模块算法设计［描述具体的操作步骤。描述操作步骤，简单的说明书内容。可以米用图形交互。 ］模块编写者［写上编写者姓名］

模块编写日期［写上编写日期：yyyy/mm/dd］模块修订者［写上修订者姓名，如果未进行修订，填写“无” ］模块修订日期［写上编写日期：yyyy/mm/dd,如果未进行修订，填写“无” ］注息事项［实现该功能项需注意的问题 ］数据库实现设计数据库模块清单［编号规则：存储过程(procedure),以DP开头：DP_{}_001、DP_{}_002函数(function),以DF开头：DF_{}_001、DF_{}_002触发器(trigger),/DT开头:DT_{}_001、DT_{}_002其不{}中的内容历时选项，如果在模块中还需要进一步细分模块， 则采用{}中的内容进一步对模块进行区分，但最多下分一级，即模块编号最多分四段。下表模块可只写到一级模块， 详细模块见下。需求跟踪时跟踪到叶子节点， 需求跟踪矩阵中只填写叶子节点。］模块编号模块名称模块英文名称模块功能简述 -存储过程实现设计存储过程名称1［存储过程是一种特殊的公用模块，它在数据库服务器上执行，这里将它单独列出来，规定其详细设计模板为：］模板编号存储过程中文名存储过程英文名称功能描述［详细描述其功能］过程算法［用形式语言详细描述其算法分析，使编程人员据此能顺利书写程序 ］调用方式

参数入口参数出口参数模块编与十［写上编写者姓名］模块编写日期［写上编写日期：yyyy/mm/dd］模块修订者［写上修订者姓名，如果未进行修订，填写“无” ］模块修订日期［写上编写日期：yyyy/mm/dd,如果未进行修订，填写“无” ］注息事项［实现该功能项需注意的问题 ］函数实现设计函数名称1［函数是一种特殊的公用模块，它在数据库服务器上执行，这里将它单独列出来，规定其详细设计模板为：］模板编号函数过程中文名函数央文名称功能描述［详细描述其功能］过程算法［用形式语言详细描述其算法分析，使编程人员据此能顺利书写程序 ］调用方式参数入口参数出口参数模块编与十［写上编写者姓名］模块编写日期［写上编写日期：yyyy/mm/dd］模块修订者［写上修订者姓名，如果未进行修订，填写“无” ］模块修订日期［写上编写日期：yyyy/mm/dd,如果未进行修订，填写“无” ］注息事项［实现该功能项需注意的问题 ］

触发器实现设计［触发器也是一种公用的模块，不过它是隐式执行，这里将它单独列出来，规定其详细设计模板为:注意：过多地使用触发器反而会使系统的效率降低。因此，凡是能用存储过程代替触发器功能的地方，一律用存储过程来实现。］模板编号触发器中文名触发器英文名称功能描述［详细描述其功能］过程算法［用形式语言详细描述其算法分析，使编程人员据此能顺利书写程序 ］激活条件模块编与十［写上编写者姓名］模块编写日期［写上编写日期：yyyy/mm/dd］模块修订者［写上修订者姓名，如果未进行修订，填写“无” ］模块修订日期［写上编写日期：yyyy/mm/dd,如果未进行修订，填写“无” ］注息事项［实现该功能项需注意的问题 ］外部接口实现设计外部接口模块清单［编号规则：DOM_［一级模块英文简称］_{}_001DOM_［一级模块英文简称］_{}_002……其中{}中的内容为可选项，女速在模块中还需要进一步细分模块， 则采用{}中的内容进一步对模块进行区分，但最多下分一级，即模块编号最多分四段。 下表模块可只写到一级模块， 详细模块见下。需求跟踪时跟踪到叶子节点，需求跟踪矩阵中只填写叶子节点。 ］接口编々接口名称接口英文名称模块功能简述外部接口1实现设计接口中文名称：接口英文名称：接口内容与功能：详细描述接口的内容与功能，如实现数据传输或数据交换。接口硬件设施：详细描述接口的硬件设施，如交换机、传感器或输出设备。接口软件或中间件：详细描述接口软件或中间件的名称、功能、使用方法、生产厂商。接口的数据结构：详细描述接口的数据结构，如文件结构、数据库表结构。这是描述的重点之一。接口的传输频率（兆/秒）：定量说明每秒最大流量。接口带宽：定量说明带宽，如多少兆。接口协议：说明具体协议。接口程序的算法分析：这是重点之二，要求用形式语言描述具体算法，使编码人员据此能顺利书写程序。外部接口2实现设计接口中文名称：接口英文名称：接口内容与功能：详细描述接口的内容与功能，如实现数据传输或数据交换。接口硬件设施：详细描述接口的硬件设施，如交换机、传感器或输出设备。接口软件或中间件：详细描述接口软件或中间件的名称、功能、使用方法、生产厂商。接口的数据结构：详细描述接口的数据结构，如文件结构、数据库表结构。这是描述的重点之一。接口的传输频率（兆/秒）：定量说明每秒最大流量。接口带宽：定量说明带宽，如多少兆。接口协议：说明具体协议。接口程序的算法分析：这是重点之二，要求用形式语言描述具体算法，使编码人员据此能顺利书写程序。其它实现设计本章描述前面没有说明的设计， 可参考概要设计说明书， 可部门角色授权设计、界面设计、 包装设计、维护设计、数据仓库设计等等。［编码规则：DNM_［一级模块英文简称］_{}_001DNM_［一级模块英文简称］_{}_002……其