cmmi 工程 详细设计指导书模板 v1.0.docVIP

详细设计说明书 广州润衡软件连锁有限公司 详细设计说明书 详细设计说明书模板 前 言 第 PAGE 2 页 目 录 TOC \o 1-3 \h \z \u 第一章 导言 2 1.1 目的 2 1.2 范围 2 1.3 术语定义 2 1.4 相关文档 3 1.5 参考资料 3 第二章 功能模块实现设计 4 2.1 公用模块实现设计 4 2.2 专用模块实现设计 5 2.3 存储过程实现设计 6 2.4 触发器实现设计 7 第三章 外部接口实现设计 8 3.1 外部接口1实现设计 8 3.2 外部接口2实现设计 8 第四章 其它实现设计 10 4.1 部门角色授权设计 10 4.2 其它详细设计 10 第五章 程序文件清单 10 详细设计说明书 文档类别使用对象 文档类别 本文档是软件系统详细设计说明书的模板，是详细设计说明书的书写标准及规范，是技术文档。 使用对象 该文档使用人员包括： 系统分析人员 系统设计人员 系统编码人员 系统测试人员 系统维护人员 导言 本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。 目的 本文档的目的旨在推动软件工程的规范化，使设计人员遵循统一的详细设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。 详细设计的详细程度，应达到可以编写程序的水平。 范围 本文档用于软件设计阶段的详细设计，它的上游（依据的基线）是概要设计说明书，它的下游是源程序清单及单元测试计划，并为单元测试报告提供测试依据。 软件详细设计的范围是：各子系统的公用模块实现设计、专用模块实现设计、存储过程实现设计、触发器实现设计、外部接口实现设计、部门角色授权设计、其它详细设计等。 按照三层结构（B/A/S）的布局，详细设计应从下面三个方面进行： 数据库服务器上的面向数据的设计：数据字典物理设计、基本表物理设计、中间表物理设计（报表设计）、临时表物理设计、视图物理设计、存储过程物理设计、触发器物理设计； 应用服务器上的面向业务逻辑的设计：接口数据设计、中间件设计、数据通讯传输设计、可视组件设计、非可视组件设计、角色授权设计、功能点设计（功能列表设计）； 浏览器上的面向对象的设计：录入修改界面设计、浏览查询界面设计、登录注册界面设计。 术语定义 序号 术语名称 术语定义 1 详细设计 在概要设计的基础上，对其功能模块或部件进行实现设计，使编程人员据此能顺利书写出程序代码。 2 存储过程 存放在数据库服务器上的一段程序，它能被其它程序调用，以完成对数据库表的某些规定操作。 3 触发器 存放在数据库服务器上的一段程序，当触发条件满足时它就被执行，以完成对数据库表的某些规定操作。 4 算法 详细设计中实现某项功能的数据处理方法及处理流程。 相关文档 源程序清单 单元测试计划及报告 用户使用手册 参考资料 软件需求规格说明书 概要设计说明书 软件合同 命名规范 功能模块实现设计 详细设计是面向模块的，或者说是面向部件（组件或构件）的，不是面向组织结构或部门单位的。一个组织或单位，根据角色的授权，可以挂上某些功能模块。若为C/S或B/A/S结构，则要说明该模块运行在哪一层上。 公用模块实现设计 公用模块的提取与设计特别重要，设计它的目的是为了复用，因此它直接影响到系统的详细设计、编程、运行的质量。公用模块设计包括如下内容： 模块编号：按照命名规则，如：G-XXX，将此公用模板编号写上。 模块名称：写上此公用模块的中文名。 模块功能：详细列出此公用模块的所有功能。 模块背景描述：对背景进行简单的描述。为什么需要此模块功能，其上下文环境。涉及业务背景内容，与需求相结合。 模块算法设计：用伪语言（例如：if…endif;case…endcase;do…enddo;…）详细描述出此公用模块的算法，标准是使程序人员据此能顺利地书写程序。在算法设计时，需要考虑下列问题： 调用参数的描述：表述参数的结构，入口出口说明。 操作对象的描述：该功能对哪些数据对象（档案）进行写操作，对哪些对象进行读操作，写操