详细设计说明书模板 .doc

《详细设计说明书模板 .doc》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、详细设计说明书模板目录第一章导言21.1目的21.2范围21.3术语定义21.4相关文档31.5参考资料3第二章功能模块实现设计42.1公用模块实现设计42.2专用模块实现设计52.3过程实存储现设计62.4触发器实现设计7第三章外部接口实现设计83.1外部接口1实现设计83.2外部接口2实现设计8第四章其它实现设计104.1部门角色授权设计104.2其它详细设计10第五章程序文件清单10第一章文档类别使用对象文档类别本文档是软件系统详细设计说明书的模板，是详细设计说明书的书写标准及规范，是技术文档。使用对象该文档使用人员包括：l系统分析

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

3、设计的范围是：各子系统的公用模块实现设计、专用模块实现设计、存储过程实现设计、触发器实现设计、外部接口实现设计、部门角色授权设计、其它详细设计等。按照三层结构（B/A/S）的布局，详细设计应从下面三个方面进行：数据库服务器上的面向数据的设计：数据字典物理设计、基本表物理设计、中间表物理设计（报表设计）、临时表物理设计、视图物理设计、存储过程物理设计、触发器物理设计；应用服务器上的面向业务逻辑的设计：接口数据设计、中间件设计、数据通讯传输设计、可视组件设计、非可视组件设计、角色授权设计、功能点设计（功能列表设计）；浏览器上的面向对象的设计：

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

5、设计说明书5.软件合同6.命名规范功能模块实现设计详细设计是面向模块的，或者说是面向部件（组件或构件）的，不是面向组织结构或部门单位的。一个组织或单位，根据角色的授权，可以挂上某些功能模块。若为C/S或B/A/S结构，则要说明该模块运行在哪一层上。1.1公用模块实现设计公用模块的提取与设计特别重要，设计它的目的是为了复用，因此它直接影响到系统的详细设计、编程、运行的质量。公用模块设计包括如下内容：1.模块编号：按照命名规则，如：G-XXX，将此公用模板编号写上。1.模块名称：写上此公用模块的中文名。2.模块功能：详细列出此公用模块的所有功

6、能。3.模块背景描述：对背景进行简单的描述。为什么需要此模块功能，其上下文环境。涉及业务背景内容，与需求相结合。4.模块算法设计：用伪语言（例如：if…endif;case…endcase;do…enddo;…）详细描述出此公用模块的算法，标准是使程序人员据此能顺利地书写程序。在算法设计时，需要考虑下列问题：调用参数的描述：表述参数的结构，入口出口说明。操作对象的描述：该功能对哪些数据对象（档案）进行写操作，对哪些对象进行读操作，写操作的对象列在哪些功能里用到。特别引用的描述：对引用的公共资源、特殊引用的函数进行说明。操作流程的描述：具体

7、的操作步骤。描述操作步骤，简单的说明书内容。可用做黑盒测试的依据。可以采用图形交互。注意事项：实现该功能项需注意的问题。5.模块调用方法：详细列出不同的调用的方式、入口参数、出口参数、异常处理。1.模块编写者：写上编写者姓名。2.模块编写日期：写上编写日期：yyyy/mm/dd。3.模块修订者：写上修订者姓名。4.模块修订日期：写上修订日期：yyyy/mm/dd。5.模块测试者：写上测试者姓名。6.模块测试日期：写上测试日期：yyyy/mm/dd。7.相关表结构设计：详细列出每个表的字段及其含义，并说明栏位的赋值及取值用途。1.1专用模块

8、实现设计非公用模块是为了处理一些特殊需求，它不可复用，设计包括如下内容：1.块编号：按照命名规则，如：M1-XXX，将此公用模板编号写上。8.模块名称：写上此模块的中文名。9.模块功能：详细列