详细设计说明书模板

整理文档很辛苦,赏杯茶钱您下走!

免费阅读已结束,点击下载阅读编辑剩下 ...

阅读已结束,您可以下载文档离线阅读编辑

资源描述

详细设计说明书详细设计说明书做您最擅长的·其余的外包Dowhatyoudobestandoutsourcetherest详细设计说明书文档编号:文档信息:文档名称:文档类别:CMMI模板密级:机密版本信息:建立日期:2005-12-21创建人:高华审核者:EPG批准人:Sunny批准日期:保管人:存放位置:编辑软件:MicrosoftOffice2003中文版详细设计说明书目录第一章导言.................................................................................................................................................................41.1目的...................................................................................................................................................................41.2范围...................................................................................................................................................................41.3术语定义...........................................................................................................................................................41.4相关文档...........................................................................................................................................................41.5参考资料...........................................................................................................................................................5第二章功能模块实现设计.........................................................................................................................................52.1公用模块实现设计...........................................................................................................................................52.2专用模块实现设计...........................................................................................................................................62.3存储过程实现设计.........................................................................................................................................172.4触发器实现设计.............................................................................................................................................17第三章外部接口实现设计.......................................................................................................................................193.1外部接口1实现设计.....................................................................................................................................193.2外部接口2实现设计.....................................................................................................................................19第四章其它实现设计...............................................................................................................................................214.1部门角色授权设计.........................................................................................................................................214.2其它详细设计.................................................................................................................................................21第五章程序文件清单...............................................................................................................................................21文档类别使用对象文档类别本文档是软件系统详细设计说明书的模板,是详细设计说明书的书写标准及规范,是技术文档。使用对象该文档使用人员包括:系统分析人员系统设计人员系统编码人员系统测试人员系统维护人员详细设计说明书第一章导言本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。1.1目的本文档的目的旨在推动软件工程的规范化,使设计人员遵循统一的详细设计书写规范,节省制作文档的时间,降低系统实现的风险,做到系统设计资料的规范性与全面性,以利于系统的实现、测试、维护、版本升级等。详细设计的详细程度,应达到可以编写程序的水平。1.2范围本文档用于软件设计阶段的详细设计,它的上游(依据的基线)是概要设计说明书,它的下游是源程序清单及单元测试计划,并为单元测试报告提供测试依据。软件详细设计的范围是:各子系统的公用模块实现设计、专用模块实现设计、存储过程实现设计、触发器实现设计、外部接口实现设计、部门角色授权设计、其它详细设计等。按照三层结构(B/A/S)的布局,详细设计应从下面三个方面进行:数据库服务器上的面向数据的设计:数据字典物理设计、基本表物理设计、中间表物理设计(报表设计)、临时表物理设计、视图物理设计、存储过程物理设计、触发器物理设计;应用服务器上的面向业务逻辑的设计:接口数据设计、中间件设计、数据通讯传输设计、可视组件设计、非可视组件设计、角色授权设计、功能点设计(功能列表设计);浏览器上的面向对象的设计:录入修改界面设计、浏览查询界面设计、登录注册界面设计。1.3术语定义序号术语名称术语定义1详细设计在概要设计的基础上,对其功能模块或部件进行实现设计,使编程人员据此能顺利书写出程序代码。2存储过程存放在数据库服务器上的一段程序,它能被其它程序调用,以完成对数据库表的某些规定操作。3触发器存放在数据库服务器上的一段程序,当触发条件满足时它就被执行,以完成对数据库表的某些规定操作。4算法详细设计中实现某项功能的数据处理方法及处理流程。1.4相关文档1.源程序清单详细设计说明书2.单元测试计划及报告3.用户使用手册1.5参考资料1.软件需求规格说明书2.概要设计说明书3.软件合同4.命名规范第二章功能模块实现设计详细设计是面向模块的,或者说是面向部件(组件或构件)的,不是面向组织结构或部门单位的。一个组织或单位,根据角色的授权,可以挂上某些功能模块。若为C/S或B/A/S结构,则要说明该模块运行在哪一层上。2.1公用模块实现设计2.1.1登录系统公用模块的提取与设计特别重要,设计它的目的是为了复用,因此它直接影响到系统的详细设计、编程、运行的质量。公用模块设计包括如下内容:1.模块编号:G-0012.模块名称:系统登录3.模块功能:1)对用户身份进行验证。2)根据用户权限进行页面控制访问。4.模块背景描述:1)用户使用系统时需要在页面之间导航2)系统需要实现对用户的重要工作的提示功能3)为了保证系统用户的安全性,提供密码修改功能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/3014.相关表结构设计:2.1.2系统快捷操作公用模块的提取与设计特别重要,设计它的目的是为了复用,因此它直接影响到系统的详细设计、编程、运行的质量。公用模块设计包括如下内容:详细设计说明书1.模块编号:G-0012.模块名称:系统登录3.模块功能:1)对用户身份进行验证。2)根据用户权限进行页面控制访问。4.模块背景描述:1)用户使用系统时需要在页面之间导航2)系统需要实现对用户的重要工作的提示功能3)为了保证系统用户的安全性,提供密码修改功能4)用户可能会在系统使用过程中需要以另外的身份登录重新进入系统5)完成相应的任务,退出系统,保证用户帐号的安全性。5.模块算法设计:入口说明:用户通过用户界面点击相应的链接。输入参数:session对象中记录的用户I

1 / 21
下载文档,编辑使用

©2015-2020 m.777doc.com 三七文档.

备案号:鲁ICP备2024069028号-1 客服联系 QQ:2149211541

×
保存成功