详细设计说明书模板教学文案.doc

详细设计说明书模板 精品文档 精品文档 收集于网络，如有侵权请联系管理员删除 收集于网络，如有侵权请联系管理员删除 精品文档 收集于网络，如有侵权请联系管理员删除 密级： ****项目 详细设计说明书 （J2EE） 中创软件工程股份有限公司 二ОО*年**月**日 文件修订记录 变更版本 修订日期 原因与修改情况描述 位置（页/段落/章节号 修订人 审核人 [详细设计说明书编写要求：关于封面、目录、正文等排版要求请参阅项目文件排版指导；正文的内容参照以下要求组织，本模板只提供参考，根据项目的不同特点，对有关章节可做必要的剪裁与调整。] 引言 1.1编写目的 说明一个软件系统中的每一个程序的设计思路。该文件可作为公司软件开发人员、综合测试人员的指导性文件。 1.2背景 开发的软件系统的名称 列出本软件系统的中文全称、英文全称及英文表示简称。 开发的软件系统的最终用户或适用的领域。 1.3定义 列出本文件中用到的专门术语定义和外文首字母组词的原词组。 1.4参考资料 列出相关的参考资料，如： 与本项目有关的上级机关的批文； 属于本项目的其他已发表的文件； 本文件中各处引用的文件、资料，包括所需用到的软件开发标准； 与该项目工作产品有关的法律法规要求。 列出这些文件资料的标题、文件编号、作者、发表日期和出版单位等，说明能够得到这些文件资料的来源。 总体设计 2.1源码目标码组织 2.1.1多项目管理 对于需要划分多个子项目的项目，必须对各子项目划分及源码组织方式进行描述。 2.1.2模块的组织 给出系统中各模块的划分及相互之间的依赖关系。 例如： 给出对系统子系统模块及包的组织的详细说明。 模块名 模块发布名称 模块说明 权限管理 cvicse-rbac.jar 负责系统的认证及授权 2.1.3包的组织 模块名 包路径 包的说明 权限管理 com.cvicse.rbac 其中：包路径的定义及描述要求如下： 命名规则：com.cvicse.产品名称. + “子包名称”；用户有特殊要求的情况下可以不遵循该规则。[注：该部分内容是否由企管部统一管理？] 各产品必须在上述描述的系统包内划分package. 系统内的通用包内的内容由系统自己决定,通用包命名为common。 在设计文档中必须清楚地进行定义，并描述各package之间的依赖关系。 要求在每个包的路径下利用package.html 描述该包的涵盖的领域说明，并作为配置项进行管理。 包描述的层次必须能够满足项目组内每个成员理解的需要。 2.1.4层次的划分 给出对系统中业务层、控制层、展现层等各层次的说明及各层次之间关系的说明。 2.1.5界面源码存放路径 资源为（如JSP、CSS等） 给出对各系统、子系统、模块的JSP/CSS/图片存放路径统一的处理要求和约束条件。 模块名称 路径 路径的说明 2.2共性设计 在此章节，对项目中用到的各构件的共性部分，进行设计说明。 对于Action及ActionForm的描述限制于Struts开发，其它内容适用于J2EE开发。 该部分设计要求至少包括如下内容： 采用的整体框架模式，各技术层次源码划分及组织规则，必须明确各个层次的相关职责。如MVC框架，必须描述清楚M、V、C各元素的代码组织方式及命名规则机制则必须写清楚。再如：如在实现中曾家BO（BusinessObject）层面或DAO层面，必须对其承担的职责进行清晰的划分。DAO对于CRUD操作的命名规则进行清晰描述。 事务处理模式 日志处理模式 异常处理模式 错误信息处理模式 数据库资源获取规则 界面模式及界面展现约束 配置文件要求 通用业务处理模式，包括分页处理等等 如struts，给出对struts配置文件的说明和统一的处理要求和约束条件，如模块化建义、ActionMapping等。 系统功能设计 设计原则是代码文档一体化，尽量利用Java Doc 来描述详细设计。 在本章节对系统的各子系统、模块进行设计说明。 每一小节，就是一个子系统模块的详细设计。 3.1Xxxxx模块 3.1.1功能概述 3.1.2页面流 xxxx jsp [尽量在原型中进行描述] 原型界面 在此仅需指明相关路径。 查询条件 在该区域：说明对应的提交路径， 必须说明HIDDEN等特殊需要描述的内容。 输入Label 名称 类型 是否可空 校验规则 匹配条件 说明[包括默认值] 认可年度 不可 = 船级社国籍 不可 = 注： FORM 表单元素类型说明： HIDDEN TEXT: 文本输入框，默认情况下与数据库的对应字段 SELECT: SELECT 必须说明是否需要参数标签，如果需要则描述为 SELECT[标签名称]，如果包括检索条件则表示为 SELECT[标签名称，条件] CHECKBO