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

《软件类详细设计说明书(模板)》由会员上传分享，免费在线阅读，更多相关内容在学术论文-天天文库。

1、软件类详细设计说明书（模板）编号:JYD-EP-RD-0B1密级:公司内部公开XXX详细设计说明书拟制人：侯殿福审核人：姜亚南批准人：文凤霞[2013年3月14日]北京竞业达数码科技有限公司BeijingJYDDigitalTechnologyCo.,Ltd详细设计说明书文件变更记录详细设计说明书目录1概$32XX模块详细设计32.1页面详细设i十32.1.1界面原32.1.2界面控32.1.3JS脚本设计032.2类详细设i十42.2.1类A42.2.2类B52.3性能设i十63XX模块详细设i十64附64.1术语和缩写同64.2参考资M61详细设计说明书模版使用说明此部分说明该模版

2、的使用前需要注意的事项，模版使用者在使用后删除此部分内容。文件编写说明：（编写文件时，请删除蓝色斜体字体文字）1、请使用标题1〜4,所有标题将自动编号。为方便大家操作，样式应用操作增加了快捷方式：标题1——Alt+1标题2——Alt+2标题3——Alt+3标题4——Alt+4标题5——Alt+5标题6Alt+6标题7——Alt+7标题8——Alt+82、文件主内容使用样式“正文样式”（宋体、小四、1.5倍行距、首行缩进2个字符），其快捷键为：正文样式——Alt+W3、表格的样式有三种：表格题注样式一一Alt+C表格文字样式——Alt+T表头文字样式——Alt+H4、图文字——Alt+P

3、5、斜体样式Alt+I6、编号样式的快捷键如下编号样式1Alt+Fl编号样式2——AIUF2编号样式3——AIHF37、表格编号样式的快捷键如下表格编号样或1Alt+F4表格编号样式2——Alt+F58、为了方便粘贴表格题注和图片题注，将表格题注和图片题注的快捷键均设置为ctrl+l详细设计说明书9、从别的文档copy文字到本文档，必须采用选择性粘贴的方式，按照“仅保留文本”方式进行粘贴。详细设计说明书1概述｛描述该文档针对概要设计的哪部分进行详细设计，主要分为哪些模块等。例如：本文档针对XX系统首页的概要设计进行详细设计。对应的概要设计为《XX系统概要设计》中的。｝2XX模块详细设计

4、2.1页面详细设计表2-1页面功能说明2.1.1界面原型｛用页面和文字相结合的方式来展现操作的流程。｝2.1.2界面控件｛针对界面上使用的特别控件进行描述，如列表控件（ectable、ext）、树控件（summer的、ext的、xtree）如：本页面总体为上下结构，总体布局采用Ext编写。上部为banner图片（60px高）和系统导航（30px）。下部又分为左右2个部分。左侧宽50px-200px（可调整），右侧为主要工作区。左侧为树形结构，采用ExtTree编写。点击左侧树上的节点刷新右侧工作区。2.1.3jS脚本设计(){针对界面上的A」AX请求进行详细说明，如请求地址、参数、返回

5、值、对应的业务逻辑方法如：页面乂上侧的邮件数提示采用Ajax方式从后台定时获取。每30s执行一次。详细设计说明书对应js方法为getMailCount参数：当前等隶入id请求地址：/mailHelp.htm?action=getMailCount返回值：当前登录人的未读邮件数针对界面上的业务逻辑联动、关键字段的各种校验(必填、长度限制、格式限制)进行说明如：当界面中举报类型选择实名举报的时候，身份证字段为必填。身份证只能是15位或者18位的字母和数字组合}表2-2界面校验说明2.2类详细设计｛描述类的主要功能。如：类A主耍处理XX系统首页的展现请求，进行参数封装，调用后台服务类或缓存类

6、返回首页需要展现的数据。｝2.2.1.1方法｛对重要算法进行详细描述，普通的数据操作性处理（增删改查）可以只提一句，详细逻辑可以不写。｝表2-3类A方法列表2.2.1.2属性表2-4类A属性列表详细设计说明书｛可列出类的属性列表，说明类的属性，属性的含义、类型等。｝2.2.1.3常量表2-5类A常量列表｛本类中使用的常量定义，常量含义，使用范围等。｝2.2.2类B｛描述类的主要功能。｝2.2.2.1方法｛对重要算法进行详细描述，普通的数据操作性处理（增删改查）可以只提一句，详细逻辑可以不写｝表2-6类B方法列表表2-7类B属性列表｛可列出类的属性列表，说明类的属性，属性的含义、类型等。

7、｝2.2.23常量表2-8类B常量列表详细设计说明书｛本类屮使用的常量定义，常量含义，使用范围等。｝2.3性能设计｛高并发：链接地址，并发量，应对措施（对应设计）。如：链接地址：/laxt/index.htm?action=display并发量：50对应措施:针对首页数据进行缓存。详细情况参见2.1类A,2.2类B。。大数据量：历史数据量，数据增量（xx条/月），应对措施。如：立案系统历史数据冇100W条，新系统上线必须将历史数据导入。数据增量