软件详细设计说明书

软件详细设计说明书 篇一:软件详细设计说明书.doc 软件详细设计说明书 项目名称:学生公寓信息管理系统 日期:年月 日 信息工程学院 目 录 1 引言 ...................................................................... 1 1.1编写目的 ............................................................. 1 1.2 项目背景 ............................................................. 1 1.3 定义 ................................................................. 1 1.4 参考资料 ............................................................. 1 2 总体设计................................................................... 2 2.1 需求概述 ............................................................. 2 2.2 软件结构 ............................................................. 2 3 程序描述................................................................... 4 3.1 下面对各模块的功能，性能，输入，输出进行具体描 述 ..................... 4 3.2 算法 ................................................................. 9 3.3 程序逻辑 ............................................................. 9 3.4 接口 ................................................................ 12 3.5测试要点 ............................................................ 12 1 引言 信息社会的高科技，商品经济化的高效益，使计算机的应用已普及到经济和社会生活的各个领域。计算机虽然与人类的关系愈来愈密切，还有人由于计算机操作不方便继续用手工劳动。为了适应现代社会人们高度强烈的时间观念，学籍管理系统软件将会为教学办公室带来了极大的方便。 1.1编写目的 本需求的编写目的在于研究学籍管理系统软件的开发途径和应用方法，主要是为了对学生公寓管理系统进行使用和维护。 本需求的预期读者是与学籍管理系统软件开发有联系的决策人，开发组成人员，扶助开发者，支持本项目的领导和公司人员，软件验证者。 该需求充分利用计算机的功能实现对系统管理、信息录入、信息查询，信息打印等的自动化控制，将会使学生公寓管理工作大大减轻，方便友好的信息管理用户界面，简便的操作，完善的数据库管理，将会使得信息管理系统极大限度地应用于现代化学生成绩管理，成为管理人员的得力助手。 1.2 项目背景 ? 项目的委托单位:河北联合大学 ? 主管部门:学生公寓管理委员会 ? 该软件系统与其他系统的关系:与学生管理相关联。 1.3 定义 本需求的编写目的在于研究学籍管理系统软件的开发途径和应用方法。 本 需求的预期读者是与学籍管理系统软件开发有联系的决策人，开发组成人员，扶助开发者，支持本项目的领导和公司人员，软件验证者。 专门术语: Data processing 数据处理feedback反馈 DTE数据终端设备 transmission传输介质 DCE数据数据设备 LAN局域网 1.4 参考资料 《软件工程基础教程》---- 刘文,朱飞雪 主编: 粘新育,陶洁 副主编:出版社: 北京大学出版社 《asp.net程序设计》 ---- 尚俊杰 编著:出版社: 清华大学出版社 《SQL Server 2008 实用教程》---- 蒋文沛 主编: 韦善周,梁凡 副主编:出版社:人民邮电出版社 《软件工程案例教程》，韩万江，机械工业出版社 2 总体设计 2.1 需求概述 (1)、系统高级管理员功能的需求: A、学生查询信息管理:可浏览,添加,修改,删除所有学生信息。 B、学生违纪信息管理:可浏览,添加,修改,删除所有违纪、考勤信息。 C、用户信息管理:管理系统中所有登录用户的信息,分配用户的权限。 D、系统后台信息管理:可浏览,添加,修改,删除后台的任务信息,包括数据管理,参数设定,权限设定 (1)、系统一般管理员功能的需求: A、晚归信息管理:可浏览所有晚归信息,添加,修改,删除属于自己添加的晚归信息。 B、考勤信息管理:可浏览所有考勤信息,添加,修改,删除属于自己添加的考勤信息。 3、系统一般用户功能的需求: A、公寓信息管理:可浏览一般的水电报修、卫生检查、物品管理等信息。 B、学生违纪信息管理:可浏览一般的考勤信息。 C、学生查询管理:可以浏览一般的学生数据信息。 2.2 软件结构 软件详细结构图1 软件详细结构图2 软件详细结构图3 篇二:最好软件详细设计说明书参考文档 中大软件详细设计D0903-0302 丁丁网上购书系统 详细设计 Version r.0.0.1 修订历史 目 录 1 2 3 4 5 6 绪言及目 标 .................................................................................................................................... 3 范 围 ................................................................................................................................................ 3 定义及缩 写 .................................................................................................................................... 3 引 用 ................................................................................................................................................ 3 角色及职 责 .................................................................................................................................... 3 工具及环 境 .................................................................................................................................... 4 6.1 6.2 6.3 6.4 7 研发硬件配 置 ......................................................................................................................... 4 研发语言及编译 器 ................................................................................................................. 4 软件支持工 具 ......................................................................................................................... 4 第三方工 具 ............................................................................................................................. 4 高层分 析 ........................................................................................................................................ 5 7.1 7.2 7.3 7.4 数据模型视 图 ......................................................................................................................... 5 抽象类视 图 ............................................................................................................................. 6 时序 图..................................................................................................................................... 6 用户界面架 构 ....................................................................................... 错误～ 未定义书签。 8 详细分 析 ...................................................................................................................................... 11 8.1 8.2 类/接口 视 图 ........................................................................................................................ 11 构件/包 视 图 ........................................................................................................................ 14 9 详细设 计 ...................................................................................................................................... 15 9.1 9.2 数据库定 义 ........................................................................................................................... 15 用户界面设 计 ....................................................................................................................... 21 1 绪言及目标 项目名称:丁丁网上购书系统 项目提出单位:丁丁图书销售公 司 项目开发者:中山大学软件师资班(第二期)第三小组 项目使 用单位:丁丁图书公司 软件的详细设计阶段是给出软件模块的内部过程描述即是模块 内部的算法设计。 本文档为“丁丁网上购书系统详细设计说明书”，主要用于为实 现系统的功能而进行的系统详细设计说明，详细描述了系统各软件组成模块的实现流程、功能、接口、编译、测试要点等内容，便于对系统的编码进行指导和约束。 本文档供项目组全体成员及项目组领导，单元测试人员阅读。 2 范围 本文档用于软件设计阶段的详细设计，该详细设计的范围是:系统各组成部分的构成、每个软件模块(或类)的属性、方法、事件，各软件模块的外部接口说明，数据用户界面设计等内容。 3 定义及缩写 4 引用 5 角色及 职责 岗位职责下载项目部各岗位职责下载项目部各岗位职责下载建筑公司岗位职责下载社工督导职责.docx 6 工具及环境 6.1 研发硬件配置 6.2 研发语言及编译器 本系统开发所用的语言是JAVA语言，开发的IDE工具是MyEclipse 5.5.1 GA. 6.3 软件支持工具 开发使用Rose, Myeclipse, Dreamweaver等软件工具。 6.4 第三方工具 7 高层分析 7.1 数据模型视图 系统数据视图如下图所示: 数据视图 篇三:软件详细设计说明书实例 软件详细设计说明书实例 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管理模 块 ................................................................................................... 错误～未定义书签。 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 需求概述 按照需求分析文档中的规格要求，使用条形码扫描器进书、借书、还书，使得信息传递准确、流畅。同时，系统最大限度地实现易安装，易维护性，易操作性，运行稳定，安全可靠。 篇四:[例子]详细设计说明书 详细设计说明书 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 查询结果类型转换 ? 测试要点 (转载自:www.CDFDS.Com 池 锝范文 网:软件详细设计说明书)数据库连接正常时 输入合理合法参数 输入参数不合理 输入参数不合法 数据库连接异常;数据库数据异常(读者姓名为空) 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值) ? 程序逻辑 篇五:软件详细设计说明书 软件详细设计说明书 Version 1.0 04/11/12 易OA系统 郑世佳_1043111044 沈珊珊_1043111279 图表目录 图1 易OA总体关系 图 ...................................................................................... 4 图2 易OA系统体系结构设 计.......................................................................... 4 图3 易OA系统整体用例图 ............................................................................... 7 图4 易OA系统登录用例实 现 ........................................................................... 8 图5 发布信息用例............................................................................................. 9 图6 还书登记用例实 现.....................................................................................10 图7 借书登记用例实 现..................................................................................... 11 图8 刊物更新用例实 现.....................................................................................12 图9 设置个人信息及签名用例实 现 ...................................................................13 图10 设置权限用例实现 ...................................................................................13 1. 介绍 1.1 目的 这个软件设计文档给易OA系统提供了开发时的详细设计，帮组开发人员了解整个系统的设计。易OA系统用于使企业内部人员方便快捷的共享信息，高效地办公协作，实现迅速、全方位的信息采集、信息处理。该系统采用B/S结构，摒弃以往C/S结构带来的消息阻塞或者来源匮乏。 1.2 范围 这个文档包含了易OA系统的详细设计。易OA系统主要是将数据库与各个GUI联系起来，对数据库进行一些必要的操作。系统使用Java、JSP、SQL Server、GUI设计等开发。 该系统的系统管理员可以对数据库进行完全的操作，分配用户名、设置权限、增加或者删除员工信息、修改资料等都是由管理员操作。而该系统的主要使用者员工可以在系统的用户界面进行 浏览信息、接受邮件、修改个人资料等。易OA系统主要针对企业内部的信息传递和文件管理，对其进行方便快捷操作。 1.3 术语表 1.4 参考资料 1.5 文档总览 这个文档余下的部分及其内容如下: 第二部分:系统概览描述了系统的一个最基本的关系，并且介绍了项目 背景。 第三部分:体系结构设计描述了系统的整体结构，把系统所有的类联系 起来。并对系统的类进行类型说明、功能描述、输入输出项定义，使系统的结构与功能清楚的展现给开发人员。然后，对设计的基本原理进行阐述。 第四部分:数据结构设计描述了数据库的相关知识，对易OA系统的数 据结构设计进行详细的说明，表明其数据结构及其功能等。 第五部分:用例实现描述了系统的各个用例是怎样实现的，并且对实现 方法进行阐述。 第六部分:用户接口设计描述了用户接口的设计方法与易用性。 第七部分:资源估计描述开发易OA系统所需的硬件或软件的 配备，比 如CPU、硬盘容量、开发平台配置等。 2. 系统概览 该系统旨在开发一款可提高企业办公效率以及扩大员工知识的系统，它不仅可自动化办公，并且实现公司的信息发布、公告通知，而且可通过内部邮件收发来保证公司内部信息的保密性。该系统通过Internet/Intranet实现外部人员的浏览及公司员工的办公。 下图是该系统的一个整体关系图，GUI、server、Database相互连接，将数据传递给用户。用户及管理员的所有操作都是基于数据库，然后通过服务器进行连接。 图1 易OA总体关系图 3. 体系结构设计 3.1 结构描述 图2 易OA系统体系结构设计 3.2 构件分解描述 名字: DatabaseConnect 类型: 类 描述: 这个类用于连接数据库，将系统的用户界面与数据库、服务器 连接起来，使用sql命令对数据库进行操作。 事件流: (1) 用户运行易OA系统; (2) 系统自动连接数据库; (3) 数据库激活 名字: LoginPage 类型: 类 描述: 这个类用于登录易OA系统，对用户名与密码进行验证，如果正 确，进入系统主页;否则，显示错误信息。 事件流: (1) 输入用户名和密码; (2) 点击登录按钮; (3) 进入系统主页 名字: UIInit 类型: 类 描述: 这个类用于对易OA系统界面初始化。 事件流: (1) 初始化界面中的各个组件; (2) 初始化界面 名字: PowerSet 类型: 类 描述: 这个类用于让管理员对员工的权限进行设置。 事件流: (1) 管理员点击“权限设置”按钮; (2) 选择需要设置权限的员工; (3) 选择权限类型; (4) 点击“确定”按钮 名字: BookManage 类型: 类 描述: 这个类用于对企业内部的图书期刊进行管理。 事件流: (1) 管理员点击“图书更新”按钮; (2) 填写图书期刊的基本信息; (3) 点击“完成”按钮; (4) 管理员点击“借书登记”按钮; (5) 填写员工与所借图书的基本信息; (6) 点击“完成”按钮; (7) 管理员点击“还书登记”按钮;