系统详细设计说明书(模板).docxVIP

XXXXXX XXXXXXXXXXXXX 项目名称 详细设计说明书 XXX 公司二〇XX年 X 月 文档修改记录 版本号 版本号 版本描述 责任人 日期 备注 V1.0 初始编制 XXXX 2012-8-31 版 本 号 示 例 ： V1.0 、 V2.0 、 V3.0 、 V4.0 、 V5.0 … … 目 录 第一章 引言 4 目的 4 背景 4 术语定义 4 参考资料 4 第二章 系统概述 6 第三章 程序 1 设计说明 7 程序描述 7 模块架构图 7 功能 7 类图 7 增加功能（功能点） 8 程序流程 9 测试和限制条件 9 备注 9 第四章 程序 2 设计说明 10 第五章 公用接口程序说明 11 全局变量 11 公用界面或接口 11 公用方法和过程 11 第六章 附件 12 详细设计评审意见 13 第一章 引言 目的 提示：简要说明编写这份详细设计说明书的目的，指出预期的读者。 本详细设计说明书的适用读者为：软件开发者、测试人员 背景 术语定义 序号 术语名称 1 2 3 4 …. 术语定义参考资料 术语定义 提示：列出所本文档所使用的参考资料，包括： A 本软件开发所经核准的合同或标书或可行性报告等文档B 软件开发计划书 C 需求分析报告 D 测试方案（若存在初稿的话） E 概要设计说明书 F 与本项目有关的已发表的文件或资料 G 本文件中各处引用的文件、资料，所采用的软件开发标准和规 注意：必须列出文件、资料的作者、标题、编号、发表日期和出版单位，以说明这些文件资料的来源。若某些文档有要求的，则要说明其级别。 序号 序号 文档名称 作者 版本/日期 1 2 3 第二章 系统概述 画出系统的体系结构图，以说明系统体系结构的实现技术，所用到的数据库主体的描述、如何实现访问数据库、如何划分程序的主体部分。可以采用 MVC 模式表述、也可以采用 UML 中的 系统设计主要是基于 MVC 设计模式，M 代表模型 Model，V 代表视图 View， C 代表控制器 Controller。MVC 模式将系统分为三层，层与层之间通过又一定的模式联系， 使数据实体与业务逻辑、业务逻辑与页面展现分离。 MVC 模式图举例如下图： View层Controller View层 Controller层 Model层 Web Browse JSF Bean service DAO Entity Bean DataBase Web Browse JSF Bean service DAO Entity Bean DataBase 1: 1.Request 1: 1.Request 2: 2.call method 3: 3.return 4: 5: 3.execute EntityDAO 6: 4.operate Entity Bean 7: 5.DB reflection 8: 6.return 9: 7.return 图 2-1 MVC 模式图 第三章 程序 1 设计说明 提示：从本章开始，逐步将各模块的功能和设计思想、容等进行逐层解剖分析 程序描述 提示：给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点。 模块架构图 提示：给出模块的代码结构，如典型的三层结构，可以用 UML 的组件图表达。 功能 提示：简要进行功能描述，可采用 IPO（即输入-处理-输出图）表示。 类图 提示：用 UML 类图利用面向对象思想设计模块代码实现，用类图表达出完整的类结构，包括类名，属性，主要方法名称，方法参数，关键的方法或算法可以用标注的方法，用伪码表达出来。类图中要表示出类与类之间关系，从属关系、调用关系等。 UML 类图举例如下： 图 3-1 类图 注意，重要的方法要做详细的说明，举例如下： 说明： 说明： BaseAbsDao： getAll():返回所有信息的列表。 getById(string id):根据 id 检索，并返回特定的对象。 2. BaseBean：…… 增加功能（功能点） 提示：简要进行功能描述，可采用 IPO（即输入-处理-输出图）表示。 功能描述 增加机构的管理信息。 输入和界面设计 提示：图、表方式清晰描述每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全条件等 类和接口设计 提示：列出本模块与其它模块的接口关系或要求列明所有接口，包括接口名称， 调用方法，接口参数结构等。 接口： 接口名称： 接口方法： 输入参数： 返回信息： 数据接口： 其他接口： 程序流程 提示：以流程图或顺序图形式给出本程序模块流转关系。包括一下参数