详细设计说明书模板概要.docVIP

####项目 详细设计说明书 (模板) 广州市信佰信息技术咨询有限公司 二〇一五年十月 文档修改记录 版本号 版本描述 责任人 日期 备注 V1.0 初始编制 XXX 2015-xx-xx V2.0 修改/审核 XXX 2015-xx-xx V3.0 发布 XXX 2015-xx-xx 目录 第一章 引言 1 1.1 目的 1 1.2 背景 1 1.3 术语定义 1 1.4 参考资料 1 1.5 文档编写格式 2 第二章 系统概述 3 第三章 程序1设计说明 4 3.1 程序描述 4 3.1.1 模块架构图 4 3.1.2 功能 4 3.1.3 类图 4 3.1.4 增加功能（功能点） 5 3.1.5 程序流程 6 3.1.6 测试和限制条件 6 3.1.7 备注 6 第四章 程序2设计说明 7 第五章 公用接口程序设计说明 8 5.1 全局变量 8 5.2 公用界面或接口 8 5.3 公用方法和过程 8 第六章 附件 9 2 3 参考资料 提示：列出所本文档所使用的参考资料，包括： A 本软件开发所经核准的合同或标书或可行性报告等文档 B 软件开发计划书 C 需求分析报告 D 测试方案（若存在初稿的话） E 概要设计说明书 F 与本项目有关的已发表的文件或资料 G 本文件中各处引用的文件、资料，所采用的软件开发标准和规范 注意：必须列出文件、资料的作者、标题、编号、发表日期和出版单位，以说明这些文件资料的来源。若某些文档有保密要求的，则要说明其保密级别。 序号 文档名称 作者 版本/日期 1 2 3 文档编写格式 一级标题：三号字体，黑体，加粗，1.5倍行距，居中。 二级标题，小三号字体，黑体，加粗，1.5倍行距，段前18磅段后6磅。 三级标题，小四号字体，黑体，加粗，1.5倍行距，段前18磅段后6磅。 三级以上标题、项：小四号字体，宋体，常规，1.5倍行距，段前18磅段后6磅。 正文：小四字体，宋体，常规，段前段后0行，1.5倍行距，缩进左右0个字符，首行缩进2个字符。 表格：五号字体，宋体，1.25倍行距，段前留0.5行，段后留0行。表头加粗。 页眉：小5号字体，填写项目名称，单划线，居中 页脚：小5号字体，页数（注意页数不包括封面），居中 系统概述 画出系统的体系结构图，以说明系统体系结构的实现技术，所用到的数据库主体的描述、如何实现访问数据库、如何划分程序的主体部分。可以采用MVC模式表述、也可以采用UML中的 系统设计主要是基于MVC设计模式，M代表模型ModelV代表视图 View， C代表控制器Controller。图2-1 图3-1 说明： BaseAbsDao： getAll():返回所有信息的列表。 getById(string id):根据id检索，并返回特定的对象。 BaseBean：…… 增加功能（功能点） 功能描述 增加机构的管理信息。 输入或界面设计 提示：图、表方式清晰描述每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等 类和接口设计 提示：列出本模块与其它模块的接口关系或要求列明所有接口，包括接口名称，调用方法，接口参数结构等。 接口： 接口名称： 接口方法： 输入参数： 返回信息： 数据接口： 其他接口： 程序流程 提示：以流程图或顺序图形式给出本程序模块流转关系。包括一下参数： 输入参数： 处理过程： 涉及的数据结构： 返回结果： 其他参数： 测试和限制条件 提示：给出详细设计中考虑的测试程序测试点和状态、参数等，以及对系统在程序运行、测试时需要做出的各种限制等。 备注 程序2设计说明 提示：与上一章类似，若有N个，则需要分开N项描述。 公用接口程序设计说明 提示：给出各类公用接口的程序的设计考虑，如全局变量、数据字典、公用界面、公用方法和过程等。 全局变量 提示：罗列各个全局变量的属性要求，包括全局变量名称、说明、数据类型、长度、取值范围等信息 名称 说明 数据类型 长度 取值范围 公用界面或接口 提示：要求描述清楚公用界面的界面布局情况，以及界面上所涉及到的各种数据项的相关属性，与界面相关的详细处理说明（有逻辑算法和计算公式，则要详细说明）、输入和输出数据要求等等，要求要附有界面的书面格式，可详细注明参见某个图表或某个相关附件 公用方法和过程 提示：介绍公用方法和过程所实现的主要功能，说明公用方法和过程所需调用的输入参数、输出参