详细设计说明书模板.doc

1、 详细设计说 明 书详 细 设 计 说 明 书做 您 最 擅 长 的 其 余 的 外 包Do what you do best and outsource the rest详细设计说 明 书文档编号： 文档信息： 文档名称： 文档类别：CMMI 模板 密 级： 机密 版本信息： 建立日期： 2005-12-21 创 建 人：高华 审 核 者：EPG 批 准 人： Sunny 批准日期： 保 管 人： 存放位置： 编辑软件：Microsoft Office 2003 中文版详细设计说 明 书目 录第一章 导言 .21.1 目的 .21.2 范围 .21.3 术语定义 .21.4 相关文档 .21

2、.5 参考资料 .3第二章 功能模块实现设计 .42.1 公用模块实现设计 .42.2 专用模块实现设计 .52.3 存储过程实现设计 .62.4 触发器实现设计 .6第三章 外部接口实现设计 .83.1 外部接口 1 实现设计 .83.2 外部接口 2 实现设计 .8第四章 其它实现设计 .104.1 部门角色授权设计 .104.2 其它详细设计 .10第五章 程序文件清单 .10文档类别使用对象文档类别本文档是软件系统详细设计说明书的模板，是 详细设计说 明书的书写标准及规范，是技 术文档。使用对象该文档使用人员包括： 系统分析人员 系统设计人员 系统编码人员 系统测试人员 系统维护人员详

3、细设计说 明 书第 一 章 导 言本章对该文档的目的、功能范 围、 术语、相关文档、参考 资料、版本更新 进行说明。1.1 目 的本文档的目的旨在推动软件工程的规范化，使 设计人员遵循 统一的详细设计书写规范， 节省制作文档的时间，降低系统实现的风险 ，做到系 统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。详细设计的详细程度，应达到可以 编写程序的水平。1.2 范 围本文档用于软件设计阶段的详细设计，它的上游（依据的基线）是概要设计说明书，它的下游是源程序清单及单元测试计划，并为单 元测试报告提供测试依据。软件详细设计的范围是：各子系统的公用模块实现设计、专 用模块实现

4、设计、存 储过程实现设计、触发器实现设计、外部接口实现设计 、部 门角色授权设计、其它详细设计等。按照三层结构（B/A/S）的布局，详细设计应从下面三个方面进行：数据库服务器上的面向数据的设计：数据字典物理设计、基本表物理设计、中 间表物理设计（报表设计）、临时表物理设计、视图物理设计、存储过程物理设计、触发器物理设计；应用服务器上的面向业务逻辑的设计：接口数据设计、中 间 件设计、数据通 讯传输设计、可视组件设计、非可视组件设计、角色授权设计 、功能点 设计（功能列表设计 ）；浏览器上的面向对象的设计：录入修改界面设计、浏览查询 界面设计、登 录注册界面设计。1.3 术 语 定 义序号 术语

5、名称 术语定义1 详细设计 在概要设计的基础上，对其功能模块或部件进行实现设计，使编程人员据此能顺利书写出程序代码。2 存储过程 存放在数据库服务器上的一段程序，它能被其它程序调用，以完成对数据库表的某些规定操作。3 触发器 存放在数据库服务器上的一段程序，当触发条件满足时它就被执行，以完成对数据库表的某些规定操作。4 算法 详细设计中实现某项功能的数据处理方法及处理流程。1.4 相 关 文 档详细设计说 明 书1. 源程序清单2. 单元测试计划及报告3. 用户使用手册1.5 参 考 资 料1. 软件需求规格说明书2. 概要设计说明书3. 软件合同4. 命名规范第 二 章 功 能 模 块 实

6、现 设 计详细设计是面向模块的，或者 说是面向部件（组件或构件）的，不是面向组织结构或部门单位的。一个组织或单位，根据角色的授权 ，可以挂上某些功能模 块。若为 C/S 或 B/A/S 结构，则要说明该模块运行在哪一层上。2.1 公 用 模 块 实 现 设 计2.1.1 登录系统公用模块的提取与设计特别重要， 设计它的目的是为了复用，因此它直接影响到系统的详细设计、编程、运行的质量。公用模块设计包括如下内容：1. 模块编号：G-0012. 模块名称：系统登录3. 模块功能：1) 对用户身份进行验证。2) 根据用户权限进行页面控制访问。4. 模块背景描述：1) 用户使用系统时需要在页面之间导航2

7、) 系统需要实现对用户的重要工作的提示功能详细设计说 明 书3) 为了保证系统用户的安全性，提供密码修改功能4) 用户可能会在系统使用过程中需要以另外的身份登录重新进入系统5) 完成相应的任务，退出系统，保证用户帐号的安全性。5. 模块算法设计：入口说明：用户通过用户界面点击相应的链接。输入参数：session 对象中记录的用户 ID出口说明：系统完成相应的操作6. 调用参数的描述：1) 输入用户名2) 输入密码操作对象的描述：1) 本功能要读取用户信息，用户对应角色权限信息管理。2) 将用户操作情况写到系统日志中，将职位信息写到职位信息列表中。3) 系统日志将在 G-003 G-005 系统

8、日志模块中作用。特别引用的描述：要使用到 G-001 系统 登录模块的功能操作流程的描述：注意事项：实现该功能项需注意的问题。7. 模块调用方法：详细列出不同的调用的方式、入口参数、出口参数、异常处理。8. 模块编写者：曾利9. 模块编写日期：2006/8/2710. 模块修订者：曾利11. 模块修订日期：写 2006/8/2812. 模块测试者：曾利13. 模块测试日期：2006/8/3014. 相关表结构设计：详细设计说 明 书2.1.2 系统快捷操作公用模块的提取与设计特别重要， 设计它的目的是为了复用，因此它直接影响到系统的详细设计、编程、运行的质量。公用模块设计包括如下内容：1. 模

9、块编号：G-0012. 模块名称：系统登录3. 模块功能：1) 对用户身份进行验证。2) 根据用户权限进行页面控制访问。4. 模块背景描述：1) 用户使用系统时需要在页面之间导航2) 系统需要实现对用户的重要工作的提示功能3) 为了保证系统用户的安全性，提供密码修改功能4) 用户可能会在系统使用过程中需要以另外的身份登录重新进入系统5) 完成相应的任务，退出系统，保证用户帐号的安全性。5. 模块算法设计：入口说明：用户通过用户界面点击相应的链接。输入参数：session 对象中记录的用户 ID出口说明：系统完成相应的操作6. 调用参数的描述：1) 输入用户名2) 输入密码操作对象的描述：1)

10、本功能要读取用户信息，用户对应角色权限信息管理。2) 将用户操作情况写到系统日志中，将职位信息写到职位信息列表中。3) 系统日志将在 G-003 G-005 系统日志模块中作用。特别引用的描述：要使用到 G-001 系统 登录模块的功能操作流程的描述：注意事项：实现该功能项需注意的问题。详细设计说 明 书7. 模块调用方法：详细列出不同的调用的方式、入口参数、出口参数、异常处理。8. 模块编写者：曾利9. 模块编写日期：2006/8/2710. 模块修订者：曾利11. 模块修订日期：写 2006/8/2812. 模块测试者：曾利13. 模块测试日期：2006/8/3014. 相关表结构设计：2

11、.1.3 系统管理公用模块的提取与设计特别重要， 设计它的目的是为了复用，因此它直接影响到系统的详细设计、编程、运行的质量。公用模块设计包括如下内容：15. 模块编号：G-00116. 模块名称：系统登录17. 模块功能：1) 对用户身份进行验证。2) 根据用户权限进行页面控制访问。18. 模块背景描述：1) 用户使用系统时需要在页面之间导航2) 系统需要实现对用户的重要工作的提示功能3) 为了保证系统用户的安全性，提供密码修改功能4) 用户可能会在系统使用过程中需要以另外的身份登录重新进入系统5) 完成相应的任务，退出系统，保证用户帐号的安全性。19. 模块算法设计：入口说明：用户通过用户界

12、面点击相应的链接。输入参数：session 对象中记录的用户 ID出口说明：系统完成相应的操作20. 调用参数的描述：1) 输入用户名详细设计说 明 书2) 输入密码操作对象的描述：1) 本功能要读取用户信息，用户对应角色权限信息管理。2) 将用户操作情况写到系统日志中，将职位信息写到职位信息列表中。3) 系统日志将在 G-003 G-005 系统日志模块中作用。特别引用的描述：要使用到 G-001 系统 登录模块的功能操作流程的描述：注意事项：实现该功能项需注意的问题。21. 模块调用方法：详细列出不同的调用的方式、入口参数、出口参数、异常处理。22. 模块编写者：曾利23. 模块编写日期：

13、2006/8/2724. 模块修订者：曾利25. 模块修订日期：写 2006/8/2826. 模块测试者：曾利27. 模块测试日期：2006/8/3028. 相关表结构设计：2.1.4 用户管理公用模块的提取与设计特别重要， 设计它的目的是为了复用，因此它直接影响到系统的详细设计、编程、运行的质量。公用模块设计包括如下内容：1. 模块编号：G-0012. 模块名称：系统登录3. 模块功能：1) 对用户身份进行验证。2) 根据用户权限进行页面控制访问。4. 模块背景描述：详细设计说 明 书1) 用户使用系统时需要在页面之间导航2) 系统需要实现对用户的重要工作的提示功能3) 为了保证系统用户的安

14、全性，提供密码修改功能4) 用户可能会在系统使用过程中需要以另外的身份登录重新进入系统5) 完成相应的任务，退出系统，保证用户帐号的安全性。5. 模块算法设计：入口说明：用户通过用户界面点击相应的链接。输入参数：session 对象中记录的用户 ID出口说明：系统完成相应的操作6. 调用参数的描述：1) 输入用户名2) 输入密码操作对象的描述：1) 本功能要读取用户信息，用户对应角色权限信息管理。2) 将用户操作情况写到系统日志中，将职位信息写到职位信息列表中。3) 系统日志将在 G-003 G-005 系统日志模块中作用。特别引用的描述：要使用到 G-001 系统 登录模块的功能操作流程的描述：注意事项：实现该功能项需注意的问题。7. 模块调用方法：详细列出不同的调用的方式、入口参数、出口参数、异常处理。8. 模块编写者：曾利9. 模块编写日期：2006/8/2710. 模块修订者：曾利11. 模块修订日期：写 2006/8/2812. 模块测试者：曾利13. 模块测试日期：2006/8/30