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