详细设计说明书实例

1、(完整版)详细设计说明书实例信息发布系统(具体设计说明书)编写单位：java理论小学期第22组设计人员：版本： 1.0编写日期：2010/9/5名目第一局部、引言 (2)1.1编写目的 (2)1.2背景 (3)1.3定义 (3)3.1程序描绘 (5)3.2整体构造 (5)3.3性能 (5)3.4输入输出项 (5)3.5算法 (5)3.6主要类的设计 (5)3.7存储安排 (7)3.8说明 (7)3.9限制条件 (7)3.10测试方案 (7)3.11尚未解决的问题 (7)4.1程序描绘 (7)4.2功能 (7)4.3性能 (8)4.4输入输出项 (8)4.5限制条件 (8)5设计特点 (8)5.

2、1 通信便捷 (8)5.2 开发速度快 (8)第六局部、工程分工 (8)附录： (9)第一局部、引言1.1编写目的本说明书在概要设计的根底上，对信息发布系统的各模块、程序分别进展了实现层面上的要求和说明。软件开发小组的产品实现成员应当阅读和参考本说明进展代码的编写、测试。1.2背景说明：a、软件系统的名称:信息发布系统b、任务提出者：ja v a理论小学期开发者：第22组成员c、实现完成的系统将可用在全部ja v a虚拟机的个人pc上.为用法者供应信息发布，浏览，评论的方式，沟通各个用户.1.3定义效劳器端api ：效劳器端设计者通过标准的api文档，供应给客户端，以便利客户端的开发，使得同时

3、进展，进步效率，节省时间。两端通过protocol协议类进展通信。gson：google供应的一个类库。通过用法这个类库，可以把把对象转换成json格式的字符串，以便利在网络中的传输。也可反向将字符串转换成对象，这样带有方法地操作对象，可以有效，便利地保证信息的沟通。json：javascript object notation，是一种轻量级的数据交换格式。易于人阅读和编写，同时也易于机器解析和生成。它基于javascript的一个子集，json采纳完全独立于语言的文本格式，这些特性使得json成为抱负的数据交换语言。1.4参考资料，相关的文件包括：a、工程需求说明；b、工程具体设计说明书；c

4、、工程概要设计说明书；参考资料：软件工程概论，王华其次局部、程序系统的构造该系统为了两大局部：客户端与效劳器端，中间通过protocol类通信。其中用法gson库来转换和逆向转换对象，实现标准包括：1、客户端主程序a、工程类型：ja v a工程；b、工程名称：信息发布系统c、编译生成文件：jar形式d、引用的组件：jdk，gson库注：以上供应的是工具集合，详细用到的类都包含在里面2、效劳器端主程序：效劳器端程序以及数据库操作类dbo3、效劳器端数据库操作验证用户，用户注册，更改密码，更新文档，新建文档，新建记录包括扫瞄记录和回复记录，查看文档，删除文档，查看记录。第三局部、根本操作局部界面设

5、计如下列图：3.1程序描绘a、客户端窗体：尽量友好的设计，让用户尽可能地关注信息的内容主体。b、效劳器端设计：该窗体在设计上尽量的符合人们的用法习惯，并且在出现非法操作的状况下，有相应的提示信息输出。3.2整体构造系统的整体大致构造为下列图：3.3性能敏捷性：窗口响应绝大局部的快捷菜单和掌握面板操作；时间特性：响应鼠标单击的时间在23秒之间；3.4输入输出项输入的数据是户执行的各种操作，包括鼠标、键盘等操作。输出是从数据库中读取的数据，或错误警告信息。3.5算法本局部没有采纳自定义的算法。3.6主要类的设计用户类数据库操作类包括静态方法3.7存储安排本程序在高级语言ja v a进展编码，挺直的

6、内存安排由ja v a运行时安排。本组件内所依靠的变量、构造要求全部在组件元素内申明。3.8说明在代码的适当出有中文代码说明。说明设计请参考visual basic 可视化程序设计的附录局部。3.9限制条件全部用户的权限都经过严格设置，不能进展权限外的操作。用户组分为三组：管理员，用户和游客。3.10测试方案测试日期、测试人员支配请参考测试方案，测试用例的详细内容，请参考测试用例说明。3.11尚未解决的问题在文件中存储文档文件中，不能存储文件名一样，但类型不同的文档。可以通过在文件名中参加文档类型来解决。但因时间关系，尚未解决。第四局部、其它附加功能及关心系统4.1 程序描绘本程序设计是客户机

7、和效劳器机通过c/s形式，建立连接。在此根底上，进展信息的共享，发布等功能。系统的目的是为了便利用户的沟通。4.2 功能主要功能就是给用户带来信息的沟通，沟通的便捷。4.3 性能敏捷性：响应鼠标操作和键盘操作。时间性：视网络响应速度而定。4.4 输入输出项从键盘，鼠标按提示输入。依效劳器响应从界面输出响应信息。4.5 限制条件在界面上掌握输入输出，效劳器端假如出错也会返回出错信息。5 设计特点5.1 通信便捷本系统客户端与效劳器端采纳json格式作为信息载体，在开发中将信息作为对象，信息传递很便捷。5.2 开发速度快由于用法通信协议商定，所以只要客户端与效劳器端商定好通信协议api文档，即可以

8、进展通信。而且挺直对对象操作，不存在类型转换的问题。这样可以使客户端与效劳器端开发同时在api文档的商定下进展，进步开发效率。第六局部、工程分工王佳龙: 负责编写gui局部代码，以及客户端局部的全部代码戴清灏:编写效劳器端代码，设计通信协议，以及对数据库的操作。负责编写具体设计文档。华从男:各方面学问全面，负责组织工作，在软件测试方面有肯定的力量。在软件开发过程负责测试文档等文档的编写。王玮柯:负责测试，组织工作。附录：效劳器端操作api文档最少需要的参数，如不全效劳器会返回type=“0的信息：效劳器和客户端之间的全部通信都封装在protocol对象中，通过对要发送的protocol对象进展

9、set 和get操作就可以通信。验证用户，用户注册，更改密码，更新文档，新建文档，新建记录包括扫瞄记录和回复记录，查看文档，删除文档，查看记录1.验证用户name,pass,limitsofauthority返回：如验证通过那么返回type=“11,不通过那么返回type=“122.用户注册name,pass,limitsofauthority返回：如注册胜利那么返回type=“21,不胜利那么返回type=“223.更改密码name,pass,newpass返回：如更改胜利那么返回type=“31,不胜利那么返回type=“324.查看文档filename可选，如为“那么查询本类的全部文档，

10、不带全部内容,filetype，replyauthor(可选，假如filename不为“那么必需)返回：如查看胜利那么返回那么返回type=“41,不胜利那么返回type=“42;文档内容在content中，文档名列表在filenames中，对应的文档6.修改文档filename,filetype,newfilename,newfiletype,filesummary返回：假如修改胜利那么返回type=“61,如不胜利那么返回type=“627.建立新记录filename,filetype,recordcontent,replyauthor返回：假如建立胜利那么返回type=“71,如不胜利那么返