项目名称-详细设计说明书 (2).docx

1、初稿V发布修订编撰：梅芝雨编撰日期：2007-05-10保密级别：机密文档版本：3.0文件编号：Q/BS-QH-3-08项目名称详细设计说明书创业慧康科技股份有限公司界面设计的内容可在此处展示。5.1.3详细设计不同的系统可使用不同的模版。PB开发的程序听使用以I、模版。方法、事件名称功能处理描述InstanceVariablesOpenCloseQueryCloseUcinitWf_Veriy()Wf_Save()Cb_add(增加)ClickCb_Delete(删除)Clickjava或.net开发的程序可使用以下模版。前台详细设计文件名称继承自方法、事件名称功能处理描述5.

2、1.3.2后台详细设计模块名称父类或实现接口方法XXX属性XXX方法（以下是对所写方法的详细解析）功能描述前置条件即前提条件，写明需要满足什么样的条件。输入项输出项后置条件发生后的结果，会产生哪些影响。数据结构与算法补充说明5.2模块02名称5.2.1模块说明不同的系统可使用不同的模版。PB开发的程序可使用以下模版。名称窗口或用户对象的名称继承自功能描述描述该模块实现的功能输入项输入的数据项。包括从数据表中获取的内容。输出项输出的数据项，包括写入数据表或报表展示的内容。处理流程简要描述业务处理流程。接口说明指和别的模块间的接口。不包括和数据库有关的数据交互。复用说明对使用复用项的说明备注其他需

3、要特别说明的内容。包括该模块的测试要点也可在其中描述。java或.net开发的程序可使用以卜.模版。名称功能描述接口与属性此处可选处理流程画流程图流程说明数据字典此处可选复用说明备注5. 2.2参考界面界面设计的内容可在此处展示。5.2.3详细设计不同的系统可使用不同的模版。PB开发的程序可使用以卜模版。java或.net开发的程序可使用以下模版。方法、事件名称功能处理描述InstanceVariablesOpenCloseQueryCloseUcinitWf_Veriy()Wf_Save()Cb_add(增加)ClickCb_Delete(删除)Click前台详细设计文件名称继

4、承自方法、事件名称功能处理描述后台详细设计模块名称父类或实现接口方法XXX属性XXX方法（以下是对所写方法的详细解析）功能描述前置条件即前提条件，写明需要满足什么样的条件。输入项输出项后置条件发生后的结果，会产生哪些影响。数据结构与算法补充说明5.3模块n名称5.3.1模块说明不同的系统可使用不同的模版。PB开发的程序可使用以下模版。名称窗口或用户对象的名称继承自功能描述描述该模块实现的功能输入项输入的数据项。包括从数据表中获取的内容。输出项输出的数据项，包括写入数据表或报表展示的内容。处理流程简要描述业务处理流程。接口说明指和别的模块间的接口。不包括和数据库有关的数据交互。复用

5、说明对使用复用项的说明备注其他需要特别说明的内容。包括该模块的测试要点也可在其中描述。java或.nel开发的程序可使用以下模版。名称功能描述接口与属性此处可选处理流程画流程图流程说明数据字典此处可选复用说明备注5.3.2参考界面界面设计的内容可在此处展示。5.3.3详细设计不同的系统可使用不同的模版。PB开发的程序町使用以卜模版。方法、事件名称功能处理描述InstanceVariablesOpenClosoQueryCloseUe_initWf_Veriy()Wf_Save()Cb_add(增加)ClickCb_Delete(删除)Clickjava或.net开发的程序可使用以下模版。5.3

6、.3.1前台详细设计文件名称继承自方法、事件名称功能处理描述后台详细设计模块名称父类或实现接口方法XXX属性XXX方法（以下是对所写方法的详细解析）功能描述前置条件即前提条件，写明需要满足什么样的条件。输入项输出项后置条件发生后的结果，会产生哪些影响。数据结构与算法补充说明6接口设计6.1接口汇总表接口名称功能说明接口A接口B接口6.2接口APB开发的程序可使用以下格式。方法、事件名称功能处理描述java或.net开发的程序可使用以下格式。模块名称父类或实现接口方法属性方法（以下是对所写方法的详细解析）功能描述前置条件输入项输出项后置条件数据结构与算法补充说明6.3接口日7数据库

7、设计备注：如果有完整的PDM,可写详见PDM文件，此章节内容可略。7. 1数据库汇总表7.1.1表汇总表表名中文描述功能说明表A表B表7.1.2视图汇总表视图名中文描述功能说明关联的表相关联的模块视图A视图B视图7.1.3存储过程汇总表存储的过程中文描述功能说明关联的表存储过程A存储过程B存储过程7.1.4触发器汇总表触发器名中文描述功能说明触发器类型所在表相关联的表触发器A触发器B触发器7.2数据库详细设计7.2.1表详细设计 表A表B7.2.2视图详细设计视图A视图B7.2.3存储过程详细设计存储过程A存储

8、过程B7.2.4触发器详细设计触发器A触发器B8非功能性设计8.1性能方面设计性能方面需求方面的特殊的详细设计。2易用性方面设计对般用户日常维护操作和系统管理的日常维护进行设计，如备份、恢复操作，数据物理安全。8.3其它非功能性设计系统在运行可靠性、安全性、扩充、容量扩大和可移植性、开放性等方面的说明。8.4错误处理8.4.1出错类别如系统对可能出现的某些错误和故障作了专门的设计考虑，给出这些错误或故障的定义和对错误进行编码。8.4.2出错处理说明将使用的恢复或再启动技术，使软件从故障点恢复执行或软件从头开始重新运行的方法。EPG版本历史日期版本说明作者2009-0

9、6-12V2.1修改EPG2011-03-15V2.2修改EPG2011-10-15V2.3将模块设计说明书、接口设计说明书、数据库设计说明书、用户界面设计说明书合并成一份详细设计说明书李定军2013-02-04V2.4修改模块设计和接口设计的内容倪慧敏2019-03-29V2.5修改公司名称及LOGO张巧英2021-03-25V3.0公司审批，正式发布EPG项目组版本历史日期版本说明作者xxxx-xx-xx8.4.3系统调整及再次开发问题未来可能对系统进行的一些调整、限制和再次开发等问题，以及详细设计中尚未解决但开发者认为在开发阶段必须解决的问题。9关键技术关键技术指项目所采用的核心技术或技

10、术难点、新技术（如果有的话）。在详细设计阶段应确认概要设计中关键技术的设置，对每一项关键技术进一步明确详细的解决方案。9.1关键技术的一般说明说明关键技术的名称、必要性、技术难点、进度、计划等（可以用表格）。2关键技术的实现方案详细介绍各项关键技术的实现方案。10其他1 引言51.1 系统简述51.2 软件设计目标51.3 参考资料51.4 术语与缩写词5规范和要求62. 1命名规则62.2 界面设计规范62.3 接口规范6模块汇总63. 1库文件说明63.2 模块列表7设计概述71.5 系统总体设计71.6 约束和假定7模块设计85.1模块01名称85.1.1模块说明85.1.2参考界面85

11、.1.3详细设计95.2 模块02名称105.2.1模块说明105.2.2参考界面11详细设计115.3.1模块说明125.3.2参考界面135.3.3详细设计13接口设计156.1接口汇总表156.2 接口A156. 3接口B16数据库设计167. 1数据库汇总表161.1表汇总表167. 1.2视图汇总表16存储过程汇总表167.1.3 触发器汇总表167.2 数据库详细设计177.2.1表详细设计177.2.2视图详细设计177.2.3存储过程详细设计177. 2.4触发器详细设计17非功能性设计188. 1性能方面设计188.2 易用性方面设计188.3 其它非功能性设计188.4 错

12、误处理188.4.1出错类别188. 4.2出错处理187. 4.3系统调整及再次开发问题19关键技术199.1关键技术的一般说明199.2关键技术的实现方案19其他191引言1.1系统简述对系统要完成什么，所面向的用户以及系统运行的环境的简短描述，这部分主要来源于需求说明书的开始部分。1.2软件设计目标这部分论述整个系统的设计目标，明确地说明哪些功能是系统决定实现而哪些时不准备实现的。同时，对于非功能性的需求例如性能、可用性等，亦需提及。需求规格说明书对于这部分的内容来说是很重要的参考，看看其中明确了的功能性以及非功能性的需求。这部分必须说清楚设计的全貌如何，务必使读者看后知道将实现的系统有

13、什么特点和功能。在随后的文档部分，将解释设计是怎么来实现这些的。1.3参考资料列出编写本报告时参考的文件（如经核准的计划任务书或合同、上级机关的批文等）、资料、技术标准,以及他们的作者、标题、编号、发布口期和出版单位。参考文档名称作者备注说明1.4术语与缩写词列出本报告中用到的专门术语的定义。术语缩写词说明2规范和要求2.1命名规则模块设计人员确定本软件的模块命名规则（例如类、函数、变更等），数据库设计人员命名规则（例如：表、视图、存储过程、触发器等），确保设计文档的风格与代码的风格保持一致。可以从组织的编程规范中摘取或引用。2界面设计规范结合用户需求和组织定义的实现与测试过程中的软件开发规范

14、（软件界面设计标准规范），阐述软件用户界面设计应遵循的规范（原则、建议等）。2.3接口规范模块设计人员确定木软件的模块命名规则（例如类、函数、变更等），确保模块设计文档的风格与代码的风格保持一致。可以从组织的编程规范中摘取或引用。3模块汇总3.1库文件说明序号文件名称说明支持库1库文件的名称该文件包含的内容支持库的文件名称234562. 2模块列表编号模块名称功能简述01020304050607084设计概述4.1系统总体设计这部分要求提供高层系统结构的描述，使用方框图来显示主要的组件及组件间的交互。最好是把逻辑结构同物理结构分离，对前者进行描述。别忘了说明图中用到的俗语和符号。备注：如果项目

15、有概要设计说明书，可写详见项目名称-概要设计说明书，此章节内容可略。3. 2约束和假定描述系统设计中最主要的约束，这些是由客户强制要求并在需求说明书写明的。说明系统是如何来适应这些约束的。另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功能辅助，那么系统可能还受到其它的约束。这种情况下，要求清楚地描述与本系统有交互的软件类型（比如某某某数据库软件，某某某EMail软件）以及这样导致的约束（比如只允许纯文本的Email）。实现的语言和平台也会对系统有约束，同样在此予以说明。对于因选择具体的设计实现而导致对系统的约束，简要地描述你的想法思路，经过怎么样的权衡,为什么要采取这样的设计等等。5模块设计5.1模块01名称5.1.1模块说明不同的系统可使用不同的模版。PB开发的程序