管理系统编辑软件informaker详细设计说明书

第I页详详细细设设计计说说明明书书模模板板第II页目录第一章导言.................................................................................................................................................................21.1目的...................................................................................................................................................................21.2范围...................................................................................................................................................................21.3术语定义...........................................................................................................................................................21.4相关文档...........................................................................................................................................................31.5参考资料...........................................................................................................................................................3第二章功能模块实现设计.........................................................................................................................................42.1公用模块实现设计...........................................................................................................................................42.2专用模块实现设计...........................................................................................................................................42.3存储过程实现设计.........................................................................................................................................102.4触发器实现设计.............................................................................................................................................10第三章外部接口实现设计.......................................................................................................................................133.1外部接口1实现设计.....................................................................................................................................133.2外部接口2实现设计.....................................................................................................................................13第四章其它实现设计...............................................................................................................................................134.1部门角色授权设计.........................................................................................................................................154.2其它详细设计.................................................................................................................................................15第五章程序文件清单...............................................................................................................................................15详细设计说明书模板-V2.0第1页文档类别使用对象文档类别本文档是软件系统详细设计说明书的模板，是详细设计说明书的书写标准及规范，是技术文档。使用对象该文档使用人员包括：系统分析人员系统设计人员系统编码人员系统测试人员系统维护人员详细设计说明书模板-V2.0第2页第一章导言本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。1.1目的本文档的目的旨在推动软件工程的规范化，使设计人员遵循统一的详细设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。详细设计的详细程度，应达到可以编写程序的水平。1.2范围本文档用于软件设计阶段的详细设计，它的上游（依据的基线）是概要设计说明书，它的下游是源程序清单及单元测试计划，并为单元测试报告提供测试依据。软件详细设计的范围是：各子系统的公用模块实现设计、专用模块实现设计、存储过程实现设计、触发器实现设计、外部接口实现设计、部门角色授权设计、其它详细设计等。按照三层结构（B/A/S）的布局，详细设计应从下面三个方面进行：数据库服务器上的面向数据的设计：数据字典物理设计、基本表物理设计、中间表物理设计（报表设计）、临时表物理设计、视图物理设计、存储过程物理设计、触发器物理设计；应用服务器上的面向业务逻辑的设计：接口数据设计、中间件设计、数据通讯传输设计、可视组件设计、非可视组件设计、角色授权设计、功能点设计（功能列表设计）；浏览器上的面向对象的设计：录入修改界面设计、浏览查询界面设计、登录注册界面设计。1.3术语定义序号术语名称术语定义1详细设计在概要设计的基础上，对其功能模块或部件进行实现设计，使编程人员据此能顺利书写出程序代码。2存储过程存放在数据库服务器上的一段程序，它能被其它程序调用，以完成对数据库表的某些规定操作。详细设计说明书模板-V2.0第3页3触发器存放在数据库服务器上的一段程序，当触发条件满足时它就被执行，以完成对数据库表的某些规定操作。4算法详细设计中实现某项功能的数据处理方法及处理流程。1.4相关文档1.源程序清单2.单元测试计划及报告3.用户使用手册1.5参考资料1.软件需求规格说明书2.概要设计说明书3.软件合同4.命名规范详细设计说明书模板-V2.0第4页第二章功能模块实现设计详细设计是面向模块的，或者说是面向部件（组件或构件）的，不是面向组织结构或部门单位的。一个组织或单位，根据角色的授权，可以挂上某些功能模块。若为C/S或B/A/S结构，则要说明该模块运行在哪一层上。2.1公用模块实现设计公用模块的提取与设计特别重要，设计它的目的是为了复用，因此它直接影响到系统的详细设计、编程、运行的质量。公用模块设计包括如下内容：2.1.11.模块编号：G-12.模块名称:运行库3.模块功能：用于各模块运行所需的库4.模块背景描述：在该库里包含了各模块建立自己所需的数据和结构的各类程序及软件，是整个软件运行及功能实现的基础和必备，是软件不可或缺的部分。5.模块算法设计：调用参数的描述：相应的选择数据，基调用的对应程序操作对象的描述：该功能需要读入相应的选择数据，并根据相应的选择运行对应的程序特别引用的描述：需要调用对应程序所需的数据操作流程的描述：1）读入选择数据，并进行相应判断2）根据选择运行程序。模块调用方法：在程序运行初期，利用使用者根据提示所选择的调用数据调用相关程序。当输入数据正确时正常运行相关程序；如果数据不正确进行提示，并自动恢复至初始界面。IF软件通过接口调用了计算机操作系统的某执行库THEN执行该指令，软件执行调用函数ELSEIF调用的库不存在THEN提示“运行库xx调用失败，缺乏相应的软件”ENDIFENDIF详细设计说明书模板-V2.0第5页7.模块编写者：黄健鸿8.模块编写日期：2012/4/129.模块修订者：马博强10.模块修订日期：2012/4/1311.模块测试者：黄健鸿12.模块测试日期：2012/4/152.1.21.模块编号：G-32.模块名称：软件升级3.模块功能：用于更新软件4.模块背景描述：软件运行的过程中数据或者是要求可能会发生变化，有时更有可能影响到软件的正常运行和基本功能的实现，因此软件需要及时更新。即及时检查软件的运行情况，提醒用户更新或者系统自动更新。5.模块算法设计：IF用户双击update程序IF软件正在运行提示“软件正在运行，请关闭软件”ELSEIF互联网无法连接提示“互联网连接失败，请重试”ELSE软件通过互联网连接到官网的更新库，检查版本IF用户使用版本为最新详细设计说明书模板-V2.0第6页THEN提示“已使用最新的版本”ELSE下载相关文件，进行覆盖ENDIFENDIFENDIFENDIF调用参数的描述：用户向计算机操作系统发出的执行指令操作对象的描述：update软件操作流程的描述：1）检查文件的内容2)如果有新的数据，将其更新到现有文件6.模块调用方法：内部调用，手动或者设置为自动更新。7.模块编写者：黄健鸿8.模块编写日期：2012/4/129.模块修订者：马博强10.模块修订日期：2012/4/1311.模块测试者：黄健鸿12.