篇一:[例子]详细设计说明书
详细设计说明书
1引言
1. 1编写目的
根据《需求规格说明书》、《概要设计说明书》,在仔细考虑讨论之后,我们对《图书管理系统》软件的功能划分、数据结构、软件总体结构的实现有了进一步的想法。我们将这些想法记录下来,作为详细设计说明书,为进一步设计软件、编写代码打下基础。
1.2背景
随着社会信息量的与日俱增,作为信息存储的主要媒体之一图书,数量、规模比以往任何时候都大的多,不论个人还是图书管理部门都需要使用方便而有效的方式来管理自己的书籍。在计算机日益普及的今天,对个人而言若采用一套行之有效的图书管理系统来管理自己的书籍,会方便许多。对图书管理部门而言,以前单一的手工检索已不能满足人们的要求,为了便于图书资料的管理需要有效的图书管理软件。
本图书管理系统软件是一套功能比较完善的数据管理软件,具有数据操作方便高效迅速等优点。该软件采用功能强大的数据库软件开发工具进行开发,具有很好的可移植性,可在应用范围较广的DOS、WINDOWS系列等操作系统上使用
1.3定义
文档中采用的专门术语的定义及缩略词简要如下:
LMS:Library Management System,图书管理系统
1.4参考资料
[1]费贤举关于图书管理系统的批文 [2]郑人杰,殷人昆,陶永雷。《实用软件工程》(第二版)。北京:清华大学出版社,1997。 [3]王立福,麻志毅。《软件工程》(第二版)。北京:北京大学出版社,2001。 [4]唐学忠,王文。《Visual Basic程序设计教程》北京:中国电力出版社,2002。
2程序系统的结构
3程序(标识符)设计说明
3.1主模块 ? 功能
建立与数据库连接 获取系统设置 运行主对话框
根据输入调用子模块
退出系统时断开与数据库的连接
? 输入项目 用户鼠标点击输入
? 程序逻辑 见右图
? 存储分配
内部数据: 数据库连接 m_pConnection _ConnectionPtr 数据库连接指针 m_IsConnected BOOL 数据库连接指示 系统设置 m_MaxLBNum int 可借图书数上限 m_MaxLBDay int 借书天数上限 子对话框 m_BookOutDlg CBookOutDlg 借书对话框 m_BookInDlg CBookInDlg 还书对话框 m_BookQuiryDlg CBookQuiryDlg 图书查询对话框 m_SysDlgCSysDlg系统操作对话框 ? 测试要点
数据库连接情况:正常情况,数据库文件缺少,外部系统异常。 系统设置获取:正常情况,外部系统异常。
对用户输入的响应: 合法输入,能够正常调用子模块;
非法输入,系统能否辨别,并作出响应(提出警告);
子模块的异常状况,系统能否及时做出响应。
3.2借书模块 ? 功能
查验输入的读者证号 运行借书对话框
获取该读者的相关信息 查验输入的图书号 登记借书 ? 输入项目
读者证号、图书书号(用户输入) ? 输出项目
读者信息(姓名);读者已借图书信息(书名、借书日期); ? 程序逻辑
? 接口
调用形式:void CBookDlg::LendBook(const _ConnectionPtr pConnection,
const int MaxLBNum)
传入参数:pConnection 数据库连接指针 MaxLBNum 系统参数(可借图书上限)
传出参数:无 ? 存储分配
内部数据: 数据库 m_pConnection _ConnectionPtr 数据库连接指针 用户界面 m_strReaderName CString读者姓名 m_strLBInf CString已借图书信息 m_strLBNum CString已借图书数显示 m_lBookID long欲借图书书号 内部参数 m_lReaderID long当前读者证号 m_MaxLBNum int 可借图书数上限 ? 测试要点
模块正常运行流程
用户输入数据检查(读者证号、图书书号),包括数据合理性检查,以及合法性检查 数据库操作
数据库连接异常时的响应情况 3.2.1 读者查验模块 ? 功能
查验输入的读者证号是否合法(即是否存在与该读者证号对应的读者记录) ? 输入项目
读者证号(整型常数),读者姓名(引用型字符串) ? 输出项目
查验结果(BOOL值) ? 程序逻辑
生成数据库查询语句 调用数据库查询模块
IF返回结果集为空(不存在该读者证号) 置读者姓名字符串为空
返回”非法读者证号” ELSE
置读者姓名字符串
返回”合法读者证号”
? 接口
调用形式:BOOL CheckReader(const long ReaderID,CString &strReaderName) 传入参数:ReaderID(常量参数传入)待查验的读者证号 m_pConnection(借书模块内的全局变量) 数据库连接指针 传出参数:读者证号存在/不存在标志(返回值)
strReaderName(传入的引用参数) 读者证号对应的读者姓名
(读者证号不存在时置为空)
? 存储分配
局部变量:数据库 pReader _RecordsetPtr 数据库查询结果集指针 查询参数 vtQuiry _variant_t 查询命令 vNull _variant_t 查询连接
类型转换 strQuiry Cstring查询命令类型转换vtemp _variant_t 查询结果类型转换 ? 测试要点
数据库连接正常时
输入合理合法参数 输入参数不合理 输入参数不合法
数据库连接异常;数据库数据异常(读者姓名为空) 3.2.2 图书查验模块 ? 功能
查验输入的图书书号是否合法 ? 输入项目
图书书号(整型常量) ? 输出项目
查验结果(BOOL值) ? 程序逻辑
生成数据库查询语句 调用数据库查询模块
IF返回结果集为空(不存在该图书书号)
返回”非法图书书号” ELSE
返回”合法图书书号”
? 接口
调用形式: BOOL CheckBook(const long BookID)
传入参数: BookID(整型常量) 带查验的图书书号 传出参数: 书号合法/不合法标志(返回值) 查验结果 ? 存储分配
局部变量: 数据库 pBook _RecordsetPtr 数据库查询结果集指针 查询参量 vtQuiry _variant_t 查询字符串 vNull _variant_t 查询连接参量 类型转换 strQuiry Cstring 查询命令类型转换 ? 测试要点
数据库连接正常 数据库数据正常 输入的书号合理合法 输入的书号不合理 输入的书号不合法 数据库数据异常 数据库连接异常
3.2.3 相关信息获取模块 ? 功能
获取合法读者的借书记录 ? 输入项目
合法读者证号(整型常量);读者已借图书信息(引用型字符串) ? 输出项目
查询操作结果(BOOL值) ? 程序逻辑
篇二:软件详细设计说明书实例
软件详细设计说明书实例
2013年5月
目录
1 引言 ..................................................................................................................................................................2
1.1
1.2
1.3
1.4
2 编写目的...............................................................................................................................................2 项目背景...............................................................................................................................................2 定义 .......................................................................................................................................................2 参考资料...............................................................................................................................................3 总体设计 .........................................................................................................................................................3
2.1
2.2 需求概述...............................................................................................................................................3 软件结构...............................................................................................................................................4
3 程序描述 .........................................................................................................................................................6
3.1
3.2
3.3
3.4
3.5
3.6
3.7
3.8
3.9
3.10 01登陆模块 .........................................................................................................................................6 02管理模块 ....................................................(本文来自:WwW.xiaOCaofAnweN.Com 小草范文 网:详细设计说明书,范例)............................................... 错误!未定义书签。 031图书信息查询模块 ............................................................................... 错误!未定义书签。 032学生信息查询模块 ............................................................................... 错误!未定义书签。 021入库管理模块 ........................................................................................ 错误!未定义书签。 022学生借书模块 ........................................................................................ 错误!未定义书签。 023学生还书模块 ........................................................................................ 错误!未定义书签。 024图书注销模块 ........................................................................................ 错误!未定义书签。 接口设计......................................................................................................... 错误!未定义书签。 测试要点 .......................................................................................................................................43
文档名称: 详细设计规格说明书
项目名称: 图书馆管理系统
项目负责人:陈新光
编写 TEST_____年_____月_____日
校对 所有小组成员_____年_____月_____日
审核 所有小组成员_____年_____月_____日
批准XXX_____年_____月_____日
开发单位__________________________________________
组员:TEST1 TEST2TEST3
1 引言
1.1 编写目的
图书管理系统详细设计是设计的第二个阶段,这个阶段的主要任务是在图书管理系统概要设计书基础上,对概要设计中产生的功能模块进行过程描述,设计功能模块的内部细节,包括算法和详细数据结构,为编写源代码提供必要的说明。
概要设计解决了软件系统总体结构设计的问题,包括整个软件系统的结构、模块划分、模块功能和模块间的联系等。详细设计则要解决如何实现各个模块的内部功能,即模块设计。具体的说,模块设计就是要为已经产生的图书管理各子系统设计详细的算法。但这并不等同于系统实现阶段用具体的语言编码,它只是对实现细节作精确的描述,这样编码阶段就可以将详细设计中对功能实现的描述,直接翻译、转化为用某种程序设计语言书写的程序。
1.2 项目背景
根据XX学校希望能够充分利用现代科技来提高图书管理的效率,在原有的办公系统基础上进行扩展,将一些可以用计算机来管理的都进行计算机化,使得图书馆管理人员工作更加方便,工作效率也更加的高。
1.3 定义
?Mysql:数据库管理软件
?DBMS:数据库管理系统
?Windows 2000/2003/XP:运行环境
?JSP :软件开发语言
?Myeclipse :开发工具
1.4 参考资料
《软件工程导论——第5版》 张海藩编著 清华大学出版社
《实用软件工程》Leszek A.Maciaszek Bruc Lee Liong著 机械工业出版社
2 总体设计
2.1 需求概述
按照需求分析文档中的规格要求,使用条形码扫描器进书、借书、还书,使得信息传递准确、流畅。同时,系统最大限度地实现易安装,易维护性,易操作性,运行稳定,安全可靠。
篇三:详细设计说明书模板范例
福建电信科学技术研究院有限公司
号码百事通
综合查询台详细设计说明书
智能网技术支援中心 版本号:V1.0
文档类型:? 需求文档 ? 计划文档 ? 设计文档 ? 测试文档 ? 用户文档 ? 工程文档 ? 维护文档
密 级:? 公开资料 ? 内部资料 ? 保密资料 ? 机密资料 状 态:? 初稿 ? 讨论稿 ? 发布
版权声明
福建电信科学技术研究院有限公司版权所有,保留一切权利。
未经本公司书面许可,任何单位和个人不得擅自摘抄、复制本文档的部分或全部,并以任何形式传播。
产品支持服务
我们将不断改进我们的产品和用户手册,使其更完善、更便于使用,您的意见和建议对我们的工作非常重要,您可以用您喜欢的任何方式与我们联系。
我们的联系地址和电话是:
公司地址:福建省福州市五一中路57号7层 邮 编:350005
电 话:+86-591-3329115转101/120分机 +86-591-3329117转101/120分机 传 真:+86-591-3329116 网 址:.cn E-Mail:
文档修改/审批记录
福建电信科学技术研究院- 1 -
目录 1 1.1 1.2 1.3 1.4 2 2.1 2.1.1 2.1.2 2.1.3 2.1.4 2.1.5 2.1.6 2.1.7 2.1.8 2.2 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.2.6 2.2.7 2.2.8
简介 错误!未定义书签。 目的 9 范围 9 参考资料 9 术语定义及说明 模块详细设计 10 客户信息显示区模块
10 9
功能概述 10 界面概述 11 类设计
12
14
关键逻辑与算法说明
访问的表或其他数据库实体 14 调用外部接口说明 14 提供调用接口说明 14
模块内部使用的公用函数/包等的说明 14
公告显示区模块
14
功能概述 14 界面概述 14 类设计
14
14
关键逻辑与算法说明
访问的表或其他数据库实体 14 调用外部接口说明 15 提供调用接口说明 15
模块内部使用的公用函数/包等的说明 15
福建电信科学技术研究院- 2 -
2.3 2.3.1 2.3.2 2.3.3 2.3.4 2.3.5 2.3.6 2.3.7 2.3.8 2.4 2.4.1 2.4.2 2.4.3 2.4.4 2.4.5 2.4.6 2.4.7 2.4.8 2.5 2.5.1 2.5.2 2.5.3 2.5.4 2.5.5 2.5.6 2.5.7
信息查询显示区模块
15
功能概述 15 界面概述 16 类设计
16
17
关键逻辑与算法说明
访问的表或其他数据库实体 17 调用外部接口说明 17 提供调用接口说明 17
模块内部使用的公用函数/包等的说明 17
号码反查显示区模块
18
功能概述 18 界面概述 19 类设计
20
20
关键逻辑与算法说明
访问的表或其他数据库实体 20 调用外部接口说明 20 提供调用接口说明 20
模块内部使用的公用函数/包等的说明 20
以旧查新显示区模块
20
功能概述 20 界面概述 21 类设计
21
21
关键逻辑与算法说明
访问的表或其他数据库实体 21 调用外部接口说明 21 提供调用接口说明 21
福建电信科学技术研究院- 3 -