软件项目的详细设计--0525教学提纲.docxVIP

目录 、详细设计文档模板 1 、项目案例 2 详细设计文档 详细设计文档是指在详细设计过程中制订详细设计报告所依据的标准。 一般说，详细设 计规格说明没有统一的标准， 有的是以伪代码的方式体现， 最后可能与源代码合为一体， 有 的可能是一些文档格式的。下面的详细设计规格说明文档模板可以作为参照。 、详细设计文档模板 1、导言 1.1目的 说明文档的目的。 1.2范围 说明文档覆盖的范围。 1.3缩写说明 定义文档中所涉及的缩写语（若无则填写无，不写） 。 1.4术语定义 定义文档中所涉及的特定术语（若无则填写无，不写） 。 1.5引用标准 列出文档制定所依据、引用的标准（若无则填写无，不写） 。 1.6参考资料 列出文档制定所需的参考资料（若无则填写无，不写，也可以放在最后写） 1.7版本更新信息 记录文档版本修改的过程，具体版本更新记录如表 X—XXX所示。 表X—XXX版本更新记录 修改编号 修改日期 修改后的版本 修改位置 修改内容描述 2、系统设计概述 本节描述的主要内容包括： （1） 简要描述系统整体结构（文字和框图相结合） 。 （2） 模块划分和分布（如果采用 00技术，则可用构件图和包图表示） （3） 系统采用的技术和实现方法。 3、 详细设计概述 本节以模块为单位，简要描述以下内容： （1） 模块用途。 （2） 模块功能。 （3） 特别约定。 4、 详细设计 本节以模块为单位，详细描述以下内容： （1） 模块的定义。 （2） 模块的关联。 （3） 输入/输出数据说明，包括变量的描述（重要的变量及用途） ，以及约束条件或限 制条件。 （4） 实现描述/算法说明，包括说明本模块的实现流程，包括条件分支和异常处理、模 块的应用逻辑、模块的数据逻辑。 这部分可以通过流程图或者伪代码的方式实现。 5、程序提交清单 程序提交清单以模块为单位分别进行描述，格式如表 X—XXX所示。 模块 文件名 文件类型 用途 、项目案例 项目案例名称：综合信息管理平台 项目案例文档：《综合信息管理平台详细设计说明书》 1、导言（可以不写） 1.1目的 本文档的目的是描述综合信息管理平台项目的详细设计，其主要内容包括系统功能简 介、系统详细设计、各个模块的三层划分、最小模块组件的伪代码。 本文档的预期读者是设计人员、开发人员、项目管理人员、测试人员。 1.2范围 该文档定义了系统的各个模块和模块接口， 但未确定单元的具体实现， 这部分内容将在 实现（编码）中确定。 1.3引用标准（参照学校要求写） 1、 企业文档格式标准 V1.1，北京长江软件有限公司。 2、 1.4参考资料 1、 1.5版本更新信息 本文档版本更新记录如表 X-XXX所示。 表X-XXX版本更新记录 修改编号 修改日期 修改后的版本 修改位置 修改内容概述 000V001 全部 初始发布 2、系统设计概述 根据综合信息管理平台的概要设计，系统分为登录管理、帐号管理、帐号组权限管理、 角色管理、日志管理、统计报表、平台管理、业务信息系统维护等模块，它们的关系如图 X—XXX所示，以下将分小节对各个部分分别进行详细设计。 综合信息管理平台 登录管理 业务信息系统管理员平台管理员业务 信息 系统 维护日统志计查报 业务信息系统管理员 平台管理员 业务 信息 系统 维护 日 统 志 计 查 报 询 表 管 理 帐 帐 权 角 帐号 异常 帐号 异常 号 号 限 色 角色 时间 角色 时间 管 组 管 管 变更 登录 变更 登录 理 管 理 理 理 报表 操作 报表 报表 操作 报表 图X—XXX模块设计图 3、详细设计概述 由于本系统采用了基于 Structs体系结构的设计，即采用 MVC的三层设计模式，采用面 向对象的Java语言以及JSP脚本语言，所以基本采用面向对象的设计方法。 在整个开发过程 中，尽可能采用复用的原则，例如采用标签库，统一数据库的基本操作，统一结果显示等。 本文档的详细设计主要是按照 Struts的MVC的三个层次分别描述视图层、控制层和模 型层模块的伪代码，为下一步的编码提供基础。 下面以登录管理模块为例进行说明，但算法流程并未给出。 若模块多，以做得最好的模块为例来讲。对于每一个视图、控制器、模型需要画出详 细的算法流程图等，共同的内容可以先写。 4、登录管理模块（下面以登录模块为例写） 登录管理模块负责用户的登录。 系统框架可分成三层结构， 即视图层、控制层和模型层, 具体如表X—XXX所示。 表X—XXX 登录管理的三层模块 视图 控制器 模型 logi n.jsp mai n.jsp Logi nForm Logi nActi on DB.java Con sta nts.java User.jav 4.1视图层 根据上述