详细设计说明书模板

《详细设计说明书模板》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、请输入文档名称易初电子技术有限公司第11页共12页请输入文档名称易初电子技术有限公司第11页共12页请输入文档名称目录1引言31.1编写目的31.2项目背景31.3名词解释31.4参考资料32软件结构概述42.1系统逻辑结构示意图如下：52.2系统模块划分及其相互关系63模块设计73.1模块1（编号XXXXXX）73.1.1功能73.1.2性能73.1.3输入项73.1.4输出项73.1.5流程/算法83.1.6接口83.1.7对应文件83.1.8测试要点83.1.9尚未解决的问题83.2模块2（编号XXXXXX）8

2、3.2.1功能83.2.2性能83.2.3输入项83.2.4输出项83.2.5流程/算法93.2.6接口9易初电子技术有限公司第11页共12页请输入文档名称3.2.7对应文件93.2.8测试要点93.2.9尚未解决的问题94需求跟踪95用户界面设计95.1用户界面图95.2用户界面与模块关系106附录10易初电子技术有限公司第11页共12页请输入文档名称【对本文档的说明：1、本文档是项目详细设计说明书的模板，主要作用是为书写详细设计说明书建立规范，在实际编写过程中可根据项目的规模对文档的内容进行增删。2、本文档中深蓝

3、色斜字体为说明性文字，黑色正常字体为需求规格说明书实际写作时必需部分。软件总体设计（概要设计）阶段确定了软件的总体结构，确定了模块的划分、模块间的接口。而软件的详细设计是在概要设计的基础上确定每个软件模块的实现算法，详细设计所产生的详细设计说明书是进行软件编码的依据。本文档提供了详细设计说明书的通用模板，具体到每个项目时，可以根据项目的特性添加必要的部分。】1引言1.1编写目的说明编写本文档的目的，并指出预期的读者。1.2项目背景这一部分需要给出如下说明：1、本项目的名称或本项目所开发的系统的名称；2、本项目的任务提

4、出者、开发者、使用者（用户）、维护机构；1.3名词解释此处列出本文档中用到的专门术语的定义和外文首字母组词的原词组。可使用表格列出，如:缩写、术语解释1.4参考资料列出与本文档相关的参考资料，例如：1、本项目的经批准的计划任务书或合同、批文等；易初电子技术有限公司第11页共12页请输入文档名称2、属于本项目的其它相关文档，如相应的需求规格说明书、概要设计说明书等；3、本文档中引用的书籍、文件、资料等，包括所需要的软件开发标准。列出上述资料的名称、作者、发布日期和出版单位（如果是公司内部资料则在出版单位处注明“内部资料

5、”）。1模块命名规则如下所示:包名命名规则vo值对象，其中存放的是每个JavaBean，其中JavaBean的命名是和数据库中的表名称是一一对应的。dbc一个有意义的名字+dbc其中的类是来操纵数据库的关闭和打开的例子：DatabaseConnection.javaAction模块名＋Action:是用来给servlet命名的例子：LoginAction.javaform模块名＋ActionForm：是用来给servlet命名的例子：LoginActionForm.javadaoI+有意义的名字+DAO，因为dao包

6、是用来定义接口的，在接口的命名中，在最前面是要加上一个字母“I”的。包中定义的每一个接口的抽象方法，都是用来让Impl类和Proxy类来实现的。例子：IUserDAO.javaImpl有意义的名字+Impl：这是用来实现具体的增、删、改、查的操作的真实实现类，不负责数据库的关闭，且直接不会被servlet调用。例子：UserBeanImpl.javaProxy代理类：一个有意义的名字＋Proxy易初电子技术有限公司第11页共12页请输入文档名称：这是用用来实现真实的实现类的，它为实现类实例化，调用实现类的方法，是实现

7、类的孪生兄弟，他负责数据库的关闭工作。例子：UserDaoproxy.javaFactory工厂类：一个有意义的名字＋Factory。这个类是用来调用dao接口的。而dao接口通过其子类Proxy实例化。例子：UserFactory.java1系统架构设计对系统的总体软件结构进行必要的描述，采用图表的方式表示出模块间的层次关系和调用关系，其详细程度必须达到在本设计说明书中出现的每个模块在图表中都有反映，以便开发人员能对系统有个整体的了解。1.1模块汇总表订单管理模块名称功能简述订单管理对订单的CURD订单审核对网上下

8、单以及本地下单进行审核库存订单查询对库存订单进行查询，方便交接单生成订单确认对货物配送的订单进行确认等相关操作交接单管理模块名称功能简述交接单管理对交接单的CURD紧急订单的查询对紧急订单或者待发订单进行查询，方便交接单生成班次查询及加急班次设置查询班次，绑定交接单，申请加急班次，处理紧急订单易初电子技术有限公司第11页共12页请输入文档名称1