完整版详细设计说明书实例.docVIP

完整版详细设计说明书实例 完整版详细设计说明书实例 PAGE / NUMPAGES 完整版详细设计说明书实例 信息宣布系统详细设计文档 信息宣布系统 (详细设计说明书 ) 编写单位： JAVA实践小学期第 22 组 设计人员： 版 本： 编写日期： 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.1 通信便利 8 5.2 开发速度快 8 第六部分、项目分工 8 附录： 9 第一部分、序言 1.1 编写目的 本说明书在大纲设计的基础上，对信息宣布系统的各模块、程序分别进行了实现层面上的要求和说明。 软件开发小组的产品实现成员应该阅读和参照本说明进行代码的编写、测试。 1.2 背景 说明： 2 信息宣布系统详细设计文档 A 、 软件系统的名称 :信息宣布系统 B 、 任务提出者： JAVA 实践小学期 开发者：第 22 组成员 C、 实现完成的系统将可用在全部 JAVA 虚假机的个人 PC 上 .为使用者供给信息宣布，阅读，谈论的方式，沟通各个用户 . 1.3 定义 服务器端 API ：服务器端设计者经过规范的 API 文档，供给给客户端，以方便客户端的开 发，使得同时进行，提高效率，节约时间。两端经过 protocol （协议类）进行通信。 Gson：Google 供给的一个类库。经过使用这个类库，能够把把对象变换成 json 格式的字符 串，以方便在网络中的传输。也可反向将字符串变换成对象，这样带有方法地操作对象，能够有效，方便地保证信息的沟通。 Json：JavaScript Object Notation ，是一种轻量级的数据交换格式。易于人阅读和编写，同时 也易于机器剖析和生成。它基于 JavaScript 的一个子集， JSON 采用完好独立于语言的文本格式，这些特点使得 JSON 成为理想的数据交换语言。 1.4 参照资料，相关的文件包括： A 、 《项目需求说明》； B 、《项目详细设计说明书》； C、《项目大纲设计说明书》； 参照资料： 《软件工程概论》，王华 第二部分、程序系统的结构 该系统为了两大部分：客户端与服务器端，中间经过 protocol 类通信。其中使用 gson 库来转 换和逆向变换对象，实现标准包括： 1、客户端主程序 A 、工程种类： JAVA 项目； B、工程名称：信息宣布系统 C、编译生成文件： jar 形式 D、引用的组件： JDK ， Gson 库 注：以上供给的是工具会集，详细用到的类都包括在里面 2、服务器端主程序： 服务器端程序以及数据库操作类（ DBO ） 3、服务器端数据库操作 考据用户，用户注册，更正密码，更新文档，新建文档，新建记录（包括阅读记录和回复记录），查察文档，删除文档，查察记录。 3 信息宣布系统详细设计文档 第三部分、基本操作部分 界面设计以以下图： 3.1 程序描述 A、客户端窗体： 尽量友好的设计，让用户尽可能地关注信息的内容主体。 B、服务器端设计： 4 信息宣布系统详细设计文档 该窗体在设计上尽量的吻合人们的使用习惯，而且在出现非法操作的情况下，有相应的提示信息输出。 3.2 整体结构 系统的整体大体结构为以下图： 3.3 性能 灵 活 性：窗口响应绝大部分的快捷菜单和控制面板操作； 时间特点：响应鼠标单击的时间在 2~3 秒之间； 3.4 输入输出项 输入的数据是户执行的各种操作，包括鼠标、键盘等操作。 输出是从数据库中读取的数据，或错误警告信息。 3.5 算法 本部分没有采用自定义的算法。 3.6 主要类的设计 用户类 5 信息宣布系统详细设计文档 数据库操作类（包括静态方法） 6 信息宣布系统详细设计文档 3.7 储藏分配 本程序在高级语言 JAVA 进行编码，直接的内存分配由 JAVA 运行时分配。 本组件内所依赖的变量、结构要求全部在组件元素内申明。 3.8 说明 在代码的合适出有中文代码说明。 说明设计请参照《 Visual Basic 可视化程序设计》的附录部分。 3.9 限制条件 所适用户的权限都经过严格设置，不能够进行权限外的操作。用户组分为三组：管理员，用户和游客。 3.10 测试计划 测试日期、测试人员安排请参照测试计划，测试用例的详细内容，请参照测试用例说明。 3.11