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

XXXXXX XXXXXXXXXXXXX 项目名称 详细设计文档修改记录 版本号 版本描述 责任人 日期 备注 V1.0 初始编制 XXXX 2012-8-31 版本号示例：V1.0、V2.0、V3.0、V4.0、V5.0……目 录 第一章 引言 4 1.1 目的 4 1.2 背景 4 1.3 术语定义 4 1.4 参考资料 4 第二章 系统概述 6 第三章 程序1设计说明 7 3.1 程序描述 7 3.1.1 模块架构图 7 3.1.2 功能 7 3.1.3 类图 7 3.1.4 增加功能（功能点） 8 3.1.5 程序流程 9 3.1.6 测试和限制条件 9 3.1.7 备注 9 第四章 程序2设计说明 10 第五章 公用接口程序说明 11 5.1 全局变量 11 5.2 公用界面或接口 11 5.3 公用方法和过程 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模式图举例如下图： 图2-1 图3-1 说明： BaseAbsDao： getAll():返回所有信息的列表。 getById(string id):根据id检索，并返回特定的对象。 BaseBean：…… 增加功能（功能点） 提示：简要进行功能描述，可采用IPO（即输入-处理-输出图）表示。 功能描述 增加机构的管理信息。 输入和界面设计 提示：图、表方式清晰描述每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等 类和接口设计 提示：列出本模块与其它模块的接口关系或要求列明所有接口，包括接口名称，调用方法，接口参数结构等。 接口： 接口名称： 接口方法： 输入参数： 返回信息： 数据接口： 其他接口： 程序流程 提示：以流程图或顺序图形式给出本程序模块流转关系。包括一下参数： 输入参数： 处理过程： 涉及的数据结构： 返回结果： 其他参数： 测试和限制条件 提示：给出详细设计中考虑的测试程序测试点和状态、参数等，以及对系统在程序运行、测试时需要做出的各种限制等。 备注 程序2设计说明 提示：与上一章类似，若有N个，则需要分开N项描述。 公用接口程序说明 提示：给出各类公用接口的程序的设计考虑，如全局变量、数据字典、公用界面、公用方法和过程等。 全局变量 提示：罗列各个全局变量的属性要求，包括全局变量名称、说明、数据类型、长度、取值范围等信息 名称 说明 数据类型 长度 取值范围 公用界面或接口 提示：要求描述清楚公用界面的界面布局情况，以及界面上所涉及到的各种数据项的相关属性，与界面相关的详细处理说明（有逻辑算法和计算公式，则要详细说明）、输入和输出数据要求等等，要求要附有界面的书面格式，可详细注明参见某个图表或某个相关附件 公用方法和过程 提示：介绍公用方法和过程所实现的主要功能，说明公用方法和过程所需调用的输入参数、输出参数以及逻辑处理和相关算法描述，并注明该公用方法和过程的适用范围。可以使用表格形式表述。 附件 提示：罗列与本详细设计报告相关的文档资料，可包括以下内容： 数据库设计的有关文档资料，如：数据字典 用户