《软件项目的详细设计》由会员分享，可在线阅读，更多相关《软件项目的详细设计（5页珍藏版）》请在装配图网上搜索。
1、目录一、详细设计文档模板1二、项目案例2详细设计文档详细设计文档是指在详细设计过程中制订详细设计报告所依据的标准。一般说，详细设计规格说明没有统一的标准，有的是以伪代码的方式体现，最后可能与源代码合为一体，有的可能是一些文档格式的。下面的详细设计规格说明文档模板可以作为参照。一、详细设计文档模板1、导言1.1 目的说明文档的目的。1.2 范围说明文档覆盖的范围。1.3 缩写说明定义文档中所涉及的缩写语（若无则填写无，不写）。1.4 术语定义定义文档中所涉及的特定术语（若无则填写无，不写）。1.5 引用标准列出文档制定所依据、引用的标准（若无则填写无，不写）。1.6 参考资料列出文档制定所需的参
2、考资料（若无则填写无，不写，也可以放在最后写）。1.7 版本更新信息记录文档版本修改的过程，具体版本更新记录如表XXXX所示。表XXXX 版本更新记录修改编号修改日期修改后的版本修改位置修改内容描述2、系统设计概述本节描述的主要内容包括：（1）简要描述系统整体结构（文字和框图相结合）。（2）模块划分和分布（如果采用OO技术，则可用构件图和包图表示）。（3）系统采用的技术和实现方法。3、详细设计概述本节以模块为单位，简要描述以下内容：（1）模块用途。（2）模块功能。（3）特别约定。4、详细设计本节以模块为单位，详细描述以下内容：（1）模块的定义。（2）模块的关联。（3）输入/输出数据说明，包括变
3、量的描述（重要的变量及用途），以及约束条件或限制条件。（4）实现描述/算法说明，包括说明本模块的实现流程，包括条件分支和异常处理、模块的应用逻辑、模块的数据逻辑。这部分可以通过流程图或者伪代码的方式实现。5、程序提交清单程序提交清单以模块为单位分别进行描述，格式如表XXXX所示。模块文件名文件类型用途二、项目案例项目案例名称：综合信息管理平台项目案例文档：综合信息管理平台详细设计说明书1、 导言（可以不写）1.1 目的本文档的目的是描述综合信息管理平台项目的详细设计，其主要内容包括系统功能简介、系统详细设计、各个模块的三层划分、最小模块组件的伪代码。本文档的预期读者是设计人员、开发人员、项目管
4、理人员、测试人员。1.2 范围该文档定义了系统的各个模块和模块接口，但未确定单元的具体实现，这部分内容将在实现（编码）中确定。1.3 引用标准（参照学校要求写）1、企业文档格式标准V1.1，北京长江软件有限公司。2、1.4 参考资料1、1.5 版本更新信息本文档版本更新记录如表X-XXX所示。表X-XXX 版本更新记录修改编号修改日期修改后的版本修改位置修改内容概述00020131215V001全部初始发布2、系统设计概述根据综合信息管理平台的概要设计，系统分为登录管理、帐号管理、帐号组权限管理、角色管理、日志管理、统计报表、平台管理、业务信息系统维护等模块，它们的关系如图XXXX所示，以下将
5、分小节对各个部分分别进行详细设计。综合信息管理平台登录管理业务信息系统管理员业务信息系统维护个人信息维护平台管理员平台管理统计报表日志查询用户管理帐号角色变更报表异常时间登录操作报表异常时间登录操作报表帐号角色变更报表角色管理权限管理帐号管理帐号组管理 图XXXX 模块设计图3、详细设计概述由于本系统采用了基于Structs体系结构的设计，即采用MVC的三层设计模式，采用面向对象的Java语言以及JSP脚本语言，所以基本采用面向对象的设计方法。在整个开发过程中，尽可能采用复用的原则，例如采用标签库，统一数据库的基本操作，统一结果显示等。本文档的详细设计主要是按照Struts的MVC的三个层次分
6、别描述视图层、控制层和模型层模块的伪代码，为下一步的编码提供基础。下面以登录管理模块为例进行说明，但算法流程并未给出。若模块多，以做得最好的模块为例来讲。对于每一个视图、控制器、模型需要画出详细的算法流程图等，共同的内容可以先写。4、登录管理模块（下面以登录模块为例写）登录管理模块负责用户的登录。系统框架可分成三层结构，即视图层、控制层和模型层，具体如表XXXX所示。表XXXX 登录管理的三层模块视图控制器模型login.jspmain.jspLoginFormLoginActionDB.javaConstants.javaUser.jav4.1 视图层根据上述的功能介绍，视图页面设计如表XX
7、XX所示。表XXXX 登录管理模块的页面设计界面JSP功能描述登录界面login.jsp登录的主页面主页main.jsp管理主页面页面中部center.jsp复用页面：页面中心部分页面上端top.jsp复用页面：页面上部分页面左端left.jsp复用页面：页面左部分页面下端bottom.jsp复用页面：页面下部分根据界面流的设计可以确定各个界面的访问入口以及界面之间的切换关系，页面流程如图XXXX所示。login.jspmain.jsp图XXXX 登录管理的页面流程4.2控制层登录管理的控制层主要是设计用户的登录事件(Action)的流程控制。表X-XXX列出了每个Action的入口（即调用Action的组件）、传递Action的ActionForm以及出口（即Action将请求发送到目标组件）。表XXXX 登录管理的控制层设计事件Action入口ActionForm出口用户登录LoginActionlogin.jspLoginFormmain.jsp4.3 模型层登录管理的模型组件负责完成用户信息的数据库操作的业务逻辑模型，建立封装了用户信息的bean，这个bean主要验证用户相关信息是否存在，并判断其权限。模型组件如表XXXX所示。表XXXX 登录管理的模型组件模型组件描述DB.jsp封装数据库操作的beanUserBean.java封装用户信息的bean其他模块类似书写
软件项目的详细设计
