详细设计说明书实例

1 / 20 详细设计说明书实例 详细设计说明书 1 引言 1. 1 编写目的 根据需求规格说明书、概要设计说明书，在仔细考虑讨论之后，我们对图书管理系统软件的功能划分、数据结构、软件总体结构的实现有了进一步的想法。我们将这些想法记录下来，作为详细设计说明书，为进一步设计软件、编写代码打下基础。 背景 随着社会信息量的与日俱增，作为信息存储的主要媒体之一图书，数量、规模比以往任何时候都大的多，不论个人还是图书管理部门都需要使用方便而有效的方式来 管理自己的书籍。在计算机日益普及的今天，对个人而言若采用一套行之有效的图书管理系统来管理自己的书籍，会方便许多。对图书管理部门而言，以前单一的手工检索已不能满足人们的要求，为了便于图书资料的管理需要有效的图书管理软件。 本图书管理系统软件是一套功能比较完善的数据管理软件，具有数据操作方便高效迅速等优点。该软件采用功能强大的数据库软件开发工具进行开发，具有很好的可移植性，可在应用范围较广的 DOS、 WINDOWS 系列等操作系统上2 / 20 使用 定义 文档中采用的专门术语的定义及缩略词简 要如下： LMS： Library Management System，图书管理系统 参考资料 1费贤举关于图书管理系统的批文 2郑人杰，殷人昆，陶永雷。实用软件工程。北京：清华大学出版社，1997。 3王立福，麻志毅。软件工程。北京：北京大学出版社， 2001。 4唐学忠，王文。 Visual Basic 程序设计教程北京：中国电力出版社， 2002。 2 程序系统的结构 3 程序设计说明 主模块 ? 功能 建 立与数据库连接 获取系统设置 运行主对话框 根据输入调用子模块 退出系统时断开与数据库的连接 ? 输入项目 用户鼠标点击输入 ? 程序逻辑 见右图 ? 存储分配 内 部 数 据 ： 数 据 库 连 接 m_pConnection _ConnectionPtr 数据库连接指针 m_IsConnected BOOL 数据库连接指示 系统设置 m_MaxLBNum int 可借图书数上3 / 20 限 m_MaxLBDay int 借 书 天 数 上 限 子 对 话 框 m_BookOutDlg CBookOutDlg 借书对话框 m_BookInDlg CBookInDlg 还书对话框 m_BookQuiryDlg CBookQuiryDlg 图书查询对话框 m_SysDlgCSysDlg 系统操作对话框 ? 测试要点 数据库连接情况：正常情况，数据库文件缺少，外部系统异常。 系统设置获取：正常情况，外部系统异常。 对用户输入的响应： 合法输入，能够正常调用子模块； 非法输入，系统能否辨别，并作出响应； 子模块的异常状 况，系统能否及时做出响应。 借书模块 ? 功能 查验输入的读者证号 运行借书对话框 获取该读者的相关信息 查验输入的图书号 登记借书 ? 输入项目 读者证号、图书书号 ? 输出项目 读者信息；读者已借图书信息； ? 程序逻辑 ? 接口 调用形式： void CBookDlg:LendBook 传 入 参 数 ： pConnection 数 据 库 连 接 指 针 MaxLBNum 系统参数 传出参数：无 ? 存储 分配 4 / 20 内 部 数 据 ： 数据库 m_pConnection _ConnectionPtr 数 据 库 连 接 指 针 用 户 界 面 m_strReaderName CString 读者姓名 m_strLBInf CString已借图书信息 m_strLBNum CString 已借图书数显示 m_lBookID long 欲借图书书号 内部参数 m_lReaderID long 当前读者证号 m_MaxLBNum int 可借图书数上限 ? 测试要点 模块正常运行流程 用户输入数据检查，包 括数据合理性检查，以及合法性检查 数据库操作 数据库连接异常时的响应情况 读者查验模块 ? 功能 查验输入的读者证号是否合法 ? 输入项目 读者证号，读者姓名 ? 输出项目 查验结果 ? 程序逻辑 生成数据库查询语句 调用数据库查询模块 IF 返回结果集为空 置读者姓名字符串为空 返回”非法读者证号” ELSE 置读者姓名字符串 返回”合法读者证号” ? 接口 调用形式： BOOL CheckReader 传入参数： ReaderID5 / 20 待查验的读者证号 m_pConnection 数据库连接指针 传出参数：读者证号存在 /不存在标志 strReaderName 读者证号对应的读者姓名 ? 存储分配 局部变量：数据库 pReader _RecordsetPtr 数据库查询结果集指针 查询参数 vtQuiry _variant_t 查询命令 vNull _variant_t 查询连接 类型转换 strQuiry Cstring 查询命令类型转换vtemp _variant_t 查询结果类型转换 ? 测试要点 数据库连接正常时 输入合理合法参数 输入参数不合理 输入参数不合法 数据库连接异常；数据库数据异常 图书查验模块 ? 功能 查验输入的图书书号是否合法 ? 输入项目 图书书号 ? 输出项目 查验结果 ? 程序逻辑 生成数据库查询语句 调用数据库查询模块 IF 返回结果集为空 返回”非法图书书号” ELSE 返回”合法图书书号” 6 / 20 ? 接口 调用形式 : BOOL CheckBook 传入参数 : BookID 带查验的图书书号 传出参数 : 书号合法 /不合法标志 查验结果 ? 存储分配 局部变量 : 数据库 pBook _RecordsetPtr 数据库查询结果集指针 查询参量 vtQuiry _variant_t 查询字符串 vNull _variant_t 查询连接参量 类型转换 strQuiry Cstring 查询命令类型 转换 ? 测试要点 数据库连接正常 数据库数据正常 输入的书号合理合法 输入的书号不合理 输入的书号不合法 数据库数据异常 数据库连接异常 相关信息获取模块 ? 功能 获取合法读者的借书记录 ? 输入项目 合法读者证号；读者已借图书信息 ? 输出项目 查询操作结果 ? 程序逻辑 软件详细设计说明书实例 2016 年 5 月 目录 1 引言 .7 / 20 .2 2 编写目的 .2 项目背景 .2 定义 .2 参考资料 .3 总体设计 .8 / 20 .3 需 求 概述 .3 软件结构 .4 3 程序描述 .6 9 / 20 01 登陆模块 .6 02 管理模块 . 错 误 ！ 未 定 义 书 签 。 031 图 书 信 息 查 询 模块 . 错误！未定义书签。 032 学 生 信 息 查 询 模块 . 错误！未定义书签。 021 入库管理模块 . 错误！未定义书签。 022 学 生 借 书 模块 . 错误！未定义书签。 023 学 生 还 书 模块 . 错误！未定10 / 20 义书签。 024 图 书 注 销 模块 . 错误！未定义书签。 接口设计 . 错 误 ！ 未 定 义 书 签 。 测试要点 .43 文档名称： 详细设计规格说明书 项目名称： 图书馆管理系统 项目负责人：陈新光 编写 TEST_年 _月 _日 校对 所有小组成员 _年 _月 _日 审核 所有小组成员 _年 _月 _日 批准 XXX_年 _月 _日 开发单位_ 组员： TEST1 TEST2TEST3 1 引言 编写目的 11 / 20 图书管理系统详细设计是设计的第二个阶段，这个阶段的主要任务是在图书管理系统概要设计书基础上，对概要设计中产生的功能模块进行过程描述，设计功能模块的内部细节，包括算法和详细数据结构，为编写源代码提供必要的说明。 概要设计解决了软件系 统总体结构设计的问题，包括整个软件系统的结构、模块划分、模块功能和模块间的联系等。详细设计则要解决如何实现各个模块的内部功能，即模块设计。具体的说，模块设计就是要为已经产生的图书管理各子系统设计详细的算法。但这并不等同于系统实现阶段用具体的语言编码，它只是对实现细节作精确的描述，这样编码阶段就可以将详细设计中对功能实现的描述，直接翻译、转化为用某种程序设计语言书写的程序。 项目背景 根据 XX 学校希望能够充分利用现代科技来提高图书管理的效率，在原有的办公系统基础上进行扩展，将一些可以 用计算机来管理的都进行计算机化，使得图书馆管理人员工作更加方便，工作效率也更加的高。 定义 ?Mysql：数据库管理软件 ?DBMS：数据库管理系统 ?Windows 2000/XX/XP：运行环境 12 / 20 ?JSP ：软件开发语言 ?Myeclipse ：开发工具 参考资料 软件工程导论 第 5 版 张海藩编著 清华大学出版社 实用软件工程 Leszek Bruc Lee Liong 著 机械 工业出版社 2 总体设计 需求概述 按照需求分析文档中的规格要求，使用条形码扫描器进书、借书、还书，使得信息传递准确、流畅。同时，系统最大限度地实现易安装，易维护性，易操作性，运行稳定，安全可靠。 信息发布系统 编写单位： 设计人员： 版 本： 编写日期： JAVA 实践小学期第 22 组 2016/9/5 目录 第一部分、引言 .13 / 20 . 2 编写目的 . 2 背景 . 3 定义 . 3 程序描述 . 5 整体结构 . 5 14 / 20 性能 . 5 输入输出项 . 5 算法 . 5 主要类的设计 . 5 存储分配 . 7 注释 .15 / 20 . 7 限制条件 . 7 测试计划 . 7 尚未解决的问题 . 7 程 序 描述 . 7 功能 . 7 16 / 20 性能 . 8 输 入 输 出项 . 8 限 制 条件 . 8 5 设 计 特点 . 8 通 信 便捷 . 8 开 发 速 度快 .17 / 20 . 8 第六部分、项目分工 . 8 附录： . 9 第一部分、引言 编写目的 本说明书在概要设计的基础上，对信息发布系统的各模块、程序分别进行了实现层面上的要求和说明。 软件开发小组的产品实现成员应该阅读和参考本说明进行代码的编写、测试。 背景 说明： A、 软件系统的名称 :信息发布系统 B、 任务提出者： JAVA 实践小学期 开发者：第 22 组成员 C、 实现完成的系统将可用 在所有 JAVA 虚拟机的个人 PC 上 .为使用者提供信息发布，浏 18 / 20 览，评论的方式，沟通各个用户 . 定义 服务器端 API ：服务器端设计者通过规范的 API 文档，提供给客户端，以方便客户端的开发，使得同时进行，提高效率，节约时间。两端通过 protocol 进行通信。 Gson： Google 提供的一个类库。通过使用这个类库，可以把把对象转换成 json 格式的字符串，以方便在网络中的传输。也可反向将字符串转换成对象，这样带有方法地操作对象，可以有效，方便地保证信息的沟通。 Json： JavaScript Object Notation，是一种轻量级的数据交换格式。易于人阅读和编写，同时也易于机器解析和生成。它基于 JavaScript 的一个子集， JSON 采用完全独立于语言的文本格式，这些特性使得 JSON 成为理想的数据交换语言。 参考资料，相关的文件包括： A、 项目需求说明； B、 项目详细设计说明书； C、 项目概要设计说明书； 参考资料： 软件工程概论，王华 第 二部分、程序系统的结构 19 / 20 该系统为了两大部分：客户端与服务器端，中间通过 protocol 类通信。其中使用 gson 库来转换和逆向转换对象，实现标准包括： 1、客户端主程序 A、工程类型： JAVA 项目； B、工程名称：信息发布系统 C、编译生成文件： jar 形式 D、引用的组件： JDK， Gson 库 注：以上提供的是工具集合，具体用到的类都包含在里面 2、服务器端主程序： 服务器端程序以及数据库操作类 3、服务器端数据库操作 验证用户，用户注册，更改密码，更新文档，新建文档，新建记录，查看文档，删除文档，查看记录。 第三部分、基本操作部分 界面设计如下