详细设计说明书模板.doc

密级： ****项目 详细设计说明书 （J2EE） 中创软件工程股份有限公司 二ОО年月日  变更版本 修订日期 原因与修改情况描述 位置（页/段落/章节号 修订人 审核人 [详细设计说明书编写要求：关于封面、目录、正文等排版要求请参阅项目文件排版指导；正文的内容参照以下要求组织，本模板只提供参考，根据项目的不同特点，对有关章节可做必要的剪裁与调整。]说明一个软件系统中的每一个程序的设计思路。该文件可作为公司软件开发人员、综合测试人员的指导性文件。开发的软件系统的名称 列出本软件系统的中文全称、英文全称及英文表示简称。 开发的软件系统的最终用户或适用的领域。 列出本文件中用到的专门术语定义和外文首字母组词的原词组。列出相关的参考资料，如： 与本项目有关的上级机关的批文； 属于本项目的其他已发表的文件； 本文件中各处引用的文件、资料，包括所需用到的软件开发标准； 与该项目工作产品有关的法律法规要求。 列出这些文件资料的标题、文件编号、作者、发表日期和出版单位等，说明能够得到这些文件资料的来源。 组织的组织给出对系统子系统包的组织的详细说明。 模块发布名称 模块说明 权限管理 cvicse-rbac.jar 负责系统的认证及授权 2.1.3包的组织 模块名 包路径 包的说明 权限管理 com.cvicse.rbac 其中：包路径的定义及描述要求如下： 命名规则：com.cvicse.产品名称. + “子包名称”；用户有特殊要求的情况下可以不遵循该规则。[注：该部分内容是否由企管部统一管理？] 各产品必须在上述描述的系统包内划分package. 系统内的通用包内的内容由系统自己决定,通用包命名为common。 在设计文档中必须清楚地进行定义，并描述各package之间的依赖关系。 要求在每个包的路径下利用package.html 描述该包的涵盖的领域说明，并作为配置项进行管理。 包描述的层次必须能够满足项目组内每个成员理解的需要。 2.1.4层次的划分给出对系统中业务层、控制层、展现层等各层次的说明及各层次之间关系的说明。存放路径（如JSP、CSS等）给出对各系统、子系统、模块的JSP/CSS/图片存放路径统一的处理要求和约束条件。 模块名称 路径 路径的说明 在此章节，对项目中用到的各构件的共性部分，进行设计说明。 对于Action及ActionForm的描述限制于Struts开发，其它内容适用于J2EE开发。如struts，给出对struts配置文件的说明和统一的处理要求和约束条件，如模块化建义、ActionMapping等。 设计原则是代码文档一体化，尽量利用Java Doc 来描述详细设计。 在本章节对系统的各子系统、模块进行设计说明。 每一小节，就是一个子系统模块的详细设计。Xxxxx模块 功能概述%Like 表示右匹配， %like% 表示中间匹配， Like% 表示右匹配 = 说明： 其它需要注释的项目 查询结果列表 列表的排序方式 内容标题内容分步【居中、居左、居右】模式 信息项目 格式 说明 保存更新项目 该区域明确对应的ActionPath 对于该部分内容，如果存在界面原型，则该部分内容仅需描述HIDDEN变量或其它特殊校验的输入项目说明。 输入Label 名称 类型 是否必输 校验规则 说明 Hidden 必输 TEXT 可输 Select[标签名] 备注：凡是不再此描述的内容，参照界面原型及数据库设计要求。 其它URL[非FORM]关联关系 连接 名称 连接的URI 相关参数 展现模式 说明 连接名称：表示连接对象的展示名称或展示内容所在HTML TABLE的column名称，如 a href=”/templet/news.jsp” 展示新闻/a, 则连接的名称为“展示新闻”。 再如，展示新闻标题列表，根据新闻标题可连接到对应的新闻。则连接的名称为“新闻标题”。 相关参数：必须说明参数的名称 展现模式：模式对话框、非模式对话框、新窗口、当前窗口 说 明：其他需要说明的内容。 界面处理提交前动作说明[针对FORM提交] 该部分内容仅描述界面相关的动作处理，如涉及的输入关联的逻辑校验，客户