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