软件类详细设计说明书(模板).doc

编号：JYD-EP-RD-0B1

密级：公司内部公开

XXX
详细设计说明书

拟 制 人： 侯殿福
审 核 人： 姜亚南
批 准 人： 文凤霞

[2013年3月14日]

北京竞业达数码科技有限公司
Beijing JYD Digital Technology Co.,Ltd
详细设计说明书
文件变更记录
版本号
日期
修改人
摘 要
审核人
批准人
备注
v1.0
2013-3-14
侯殿福
新建详细设计说明书模版
姜亚南
文凤霞

v2.0
2013-5-14
侯殿福
对模块的详细设计过程进行了修改
姜亚南
文凤霞

目录
1 概述 3
2 XX模块详细设计 3
2.1 页面详细设计 3
2.1.1 界面原型 3
2.1.2 界面控件 3
2.1.3 JS脚本设计() 3
2.2 类详细设计 4
2.2.1 类A 4
2.2.2 类B 5
2.3 性能设计 6
3 XX模块详细设计 6
4 附录 6
4.1 术语和缩写词 6
4.2 参考资料 6

1
模版使用说明
此部分说明该模版的使用前需要注意的事项，模版使用者在使用后删除此部分内容。
文件编写说明：（编写文件时，请删除蓝色斜体字体文字）
1、 请使用标题1～4，所有标题将自动编号。
为方便大家操作，样式应用操作增加了快捷方式：
标题1——Alt＋1
标题2——Alt＋2
标题3——Alt＋3
标题4——Alt＋4
标题5——Alt＋5
标题6——Alt+6
标题7——Alt+7
标题8——Alt+8
2、 文件主内容使用样式“正文样式”(宋体、小四、1.5倍行距、首行缩进2个字符)，其快捷键为：
正文样式——Alt＋W
3、表格的样式有三种：
表格题注样式——Alt＋C
表格文字样式——Alt＋T
表头文字样式——Alt＋H
4、图文字——Alt＋P
5、斜体样式——Alt＋I
6、编号样式的快捷键如下
编号样式1——Alt+F1
编号样式2——Alt+F2
编号样式3——Alt+F3
7、表格编号样式的快捷键如下
表格编号样式1——Alt+F4
表格编号样式2——Alt+F5
8、为了方便粘贴表格题注和图片题注，将表格题注和图片题注的快捷键均设置为ctrl+l
9、从别的文档copy文字到本文档，必须采用选择性粘贴的方式，按照“仅保留文本”方式进行粘贴。

1 概述
{描述该文档针对概要设计的哪部分进行详细设计，主要分为哪些模块等。
例如：本文档针对XX系统首页的概要设计进行详细设计。对应的概要设计为《XX系统概要设计》中的第XX节XX系统首页。
}
2 XX模块详细设计
2.1 页面详细设计
表 21 页面功能说明
编号
页面名称（包括路径）
主要功能说明
A
/XX模块/edit.jsp
XX信息的编辑界面
B
/XX模块/display.jsp
XX信息的显示界面

2.1.1 界面原型
{用页面和文字相结合的方式来展现操作的流程。}
2.1.2 界面控件
{针对界面上使用的特别控件进行描述，如列表控件(ectable、ext)、树控件(summer的、ext的、xtree)
如：
本页面总体为上下结构，总体布局采用Ext编写。上部为banner图片（60px高）和系统导航（30px）。下部又分为左右2个部分。左侧宽50px－200px（可调整），右侧为主要工作区。左侧为树形结构，采用ExtTree编写。点击左侧树上的节点刷新右侧工作区。
}
2.1.3 JS脚本设计()
{
针对界面上的AJAX请求进行详细说明，如请求地址、参数、返回值、对应的业务逻辑方法
如：
页面又上侧的邮件数提示采用Ajax方式从后台定时获取。每30s执行一次。
对应js方法为getMailCount
参数：当前等录入id
请求地址：/mailHelp.htm?action=getMailCount
返回值：当前登录人的未读邮件数
针对界面上的业务逻辑联动、关键字段的各种校验(必填、长度限制、格式限制)进行说明
如：
当界面中举报类型选择实名举报的时候，身份证字段为必填。身份证只能是15位或者18位的字母和数字组合
}
表 22界面校验说明
字段名
显示名
必填
其他校验
C_Name
登录名
是
取值范围{0-9A-Za-z}

2.2 类详细设计
2.2.1 类A
{描述类的主要功能。
如：类A主要处理XX系统首页的展现请求，进行参数封装，调用后台服务类或缓存类返回首页需要展现的数据。
}
2.2.1.1 方法
{对重要算法进行详细描述，普通的数据操作性处理（增删改查）可以只提一句，详细逻辑可以不写。}
表 23类A方法列表
方法名
输入
输出
说明
max
int arg1
int arg2
int
比较输入的2个参数，返回大的。
min
int arg1
int arg2
int
比较输入的2个参数，返回小的。
2.2.1.2 属性
表 24类A属性列表
属性名
类型
说明
xxxDAO
IXxxDAO
Xx模块数据库处理DAO
{可列出类的属性列表，说明类的属性，属性的含义、类型等。}
2.2.1.3 常量
表 25 类A常量列表
常量名
类型
说明
BEAN_NAME_XXXDAO
String
XXXDAO的一个bean名称
{本类中使用的常量定义，常量含义，使用范围等。}

2.2.2 类B
{描述类的主要功能。}
2.2.2.1 方法
{对重要算法进行详细描述，普通的数据操作性处理（增删改查）可以只提一句，详细逻辑可以不写}
表 26 类B方法列表
方法名
输入
输出
说明
max
int arg1
int arg2
int
比较输入的2个参数，返回大的。
min
int arg1
int arg2
int
比较输入的2个参数，返回小的。
2.2.2.2 属性
表 27类B属性列表
属性名
类型
说明
xxxDAO
IXxxDAO
Xx模块数据库处理DAO
{可列出类的属性列表，说明类的属性，属性的含义、类型等。}

2.2.2.3 常量
表 28 类B常量列表
常量名
类型
说明
BEAN_NAME_XXXDAO
String
XXXDAO的一个bean名称
{本类中使用的常量定义，常量含义，使用范围等。}

2.3 性能设计
{
高并发：链接地址，并发量，应对措施（对应设计）。
如：链接地址：/laxt/index.htm?action=display
并发量：50
对应措施：针对首页数据进行缓存。详细情况参见2.1类A，2.2类B。。
大数据量：历史数据量，数据增量（xx条/月），应对措施。
如：
立案系统历史数据有100W条，新系统上线必须将历史数据导入。
数据增量：100条/月
对应措施：列表显示界面采用数据库分页方式
}

3 XX模块详细设计

4 附录
4.1 术语和缩写词
{列出本文档中用到的术语及缩写词，可以给出简要说明。}
4.2 参考资料
{概要设计说明书}
{需求规格说明书}
{本文档的参考资料，包括委托方提供的有关资料，本文档所引用的有关标准及与本文档中涉及技术相关的资料、规范等，仅可能列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源等内容。}
第6页