软件详细设计说明书

1 / 17 软件详细设计说明书 软件详细设计说明书 项目名称：学生公寓信息管理系统 日期：年月 日 信息工程学院 目 录 1 引言 . 1 编写目的 . 1 项 目 背景 . 1 定义 . 1 参 考 资料 . 1 2 总体设2 / 17 计 . 2 需 求 概述 . 2 软 件 结构 . 2 3 程序描述 . 4 下面对各模块的功能，性能，输入，输出进行具体描述 . 4 算法 . 9 程 序 逻辑 . 9 接口 . 12 3 / 17 测试要点 . 12 1 引言 信息社会的高科技，商品经济化的高效益，使计算机的应用已普及到经济和社会生活的各个领域。计算机虽然与人类的关系愈来愈密切，还有人由于计算机操作不方便继续用手工劳动。为了适应现代社会人们高度强烈的时间观念，学籍管理系统软 件将会为教学办公室带来了极大的方便。 编写目的 本需求的编写目的在于研究学籍管理系统软件的开发途径和应用方法，主要是为了对学生公寓管理系统进行使用和维护。 本需求的预期读者是与学籍管理系统软件开发有联系的决策人，开发组成人员，扶助开发者，支持本项目的领导和公司人员，软件验证者。 该需求充分利用计算机的功能实现对系统管理、信息录入、信息查询，信息打印等的自动化控制，将会使学生公寓管理工作大大减轻，方便友好的信息管理用户界面，简便的操作，完善的数据库管理，将会使得 信息管理系统极大限度地应用于现代化学生成绩管理，成为管理人员的得力助4 / 17 手。 项目背景 项目的委托单位：河北联合大学 主管部门：学生公寓管理委员会 该软件系统与其他系统的关系：与学生管理相关联。 定义 本需求的编写目的在于研究学籍管理系统软件的开发途径和应用方法。 本 需求的预期读者是与学籍管理系统软件开发有联系的决策人，开发组成人员，扶助开发者，支持本项目的领导和公司人员，软件验证者。 专门术语： Data processing 数据处理 feedback 反馈 DTE 数据终端设备 transmission 传输介质 DCE 数据数据设备 LAN 局域网 参考资料 软件工程基础教程 - 刘文 ,朱飞雪 主编： 粘新育 ,陶洁 副主编：出版社： 北京大学出版社 程序设计 - 尚俊杰 编著：出版社： 清华大学出版社 SQL Server XX 实用教程 - 蒋文沛 主编： 韦5 / 17 善周 ,梁凡 副主编：出版社 :人民邮电出版社 软件工程案例教程，韩万江，机械工业出版社 2 总体设计 需求概述 、系统高级管理员功能的需求： A、学生查询信息管理 :可浏览 ,添加 ,修改 ,删除所有学生信息。 B、学生违纪信息管理 :可浏览 ,添加 ,修改 ,删除所有违纪、考勤信息。 C、用户信息管理 :管理系统中所有登录用户的信息 ,分配用户的权限。 D、系统后台信息管理 :可浏览 ,添加 ,修改 ,删除后台的任务信息 ,包括数据管理 ,参数设定 ,权限设定 、系统一般管理员功 能的需求： A、晚归信息管理 :可浏览所有晚归信息 ,添加 ,修改 ,删除属于自己添加的晚归信息。 B、考勤信息管理 :可浏览所有考勤信息 ,添加 ,修改 ,删除属于自己添加的考勤信息。 3、系统一般用户功能的需求： A、公寓信息管理 :可浏览一般的水电报修、卫生检查、物品管理等信息。 B、学生违纪信息管理 :可浏览一般的考勤信息。 C、学生查询管理 :可以浏览一般的学生数据信息。 6 / 17 软件结构 软件详细结构图 1 软件详细 结构图 2 软件详细结构图 3 软件详细设计说明书实例 2016 年 5 月 目录 1 引言 .2 2 编写目的 .2 项目背景 .7 / 17 .2 定义 .2 参考资料 .3 总体设计 .3 需 求 概述 .3 软件结构 .4 3 程序描述 .8 / 17 .6 01 登陆模块 .6 02 管理模块 . 错 误 ！ 未 定 义 书 签 。 031 图 书 信 息 查 询 模块 . 错误！未定义书签。 032 学 生 信 息 查 询 模9 / 17 块 . 错误！未定义书签。 021 入库管理模块 . 错误！未定义书签。 022 学 生 借 书 模块 . 错误！未定义书签。 023 学 生 还 书 模块 . 错误！未定义书签。 024 图 书 注 销 模块 . 错误！未定义书签。 接口设计 . 错 误 ！ 未 定 义 书 签 。 测试要点 .43 文档名称： 详细设计规格说明书 10 / 17 项目名称： 图书馆管理系统 项目负责人：陈新光 编写 TEST_年 _月 _日 校对 所有小组成员 _年 _月 _日 审核 所有小组成员 _年 _月 _日 批准 XXX_年 _月 _日 开发单位_ 组员： TEST1 TEST2TEST3 1 引言 编写目的 图书管理系统详细设计是设计 的第二个阶段，这个阶段的主要任务是在图书管理系统概要设计书基础上，对概要设计中产生的功能模块进行过程描述，设计功能模块的内部细节，包括算法和详细数据结构，为编写源代码提供必要的说明。 概要设计解决了软件系统总体结构设计的问题，包括整个软件系统的结构、模块划分、模块功能和模块间的联系等。详细设计则要解决如何实现各个模块的内部功能，即模块设计。具体的说，模块设计就是要为已经产生的图书管理各子系统设计详细的算法。但这并不等同于系统实现阶段用具体的语言编码，它只是对实现细节作精确的描述，这样11 / 17 编码阶段就可 以将详细设计中对功能实现的描述，直接翻译、转化为用某种程序设计语言书写的程序。 项目背景 根据 XX 学校希望能够充分利用现代科技来提高图书管理的效率，在原有的办公系统基础上进行扩展，将一些可以用计算机来管理的都进行计算机化，使得图书馆管理人员工作更加方便，工作效率也更加的高。 定义 ?Mysql：数据库管理软件 ?DBMS：数据库管理系统 ?Windows 2000/XX/XP：运行环境 ?JSP ：软件开发语言 ?Myeclipse ：开发工具 参考资料 软件工程导论 第 5 版 张海藩编著 清华大学出版社 实用软件工程 Leszek Bruc Lee Liong 著 机械工业出版社 2 总体设计 需求概述 按照需求分析文档中的规格要求，使用条形码扫描器进书、借书、还书，使得信息传递准确、流畅。同时，系12 / 17 统最大限度地实现易安装，易维护性，易操作性，运行稳定，安全可靠。 软件详细设计说明书 Version 04/11/12 易 OA 系统 郑世佳 _1043111044 沈珊珊 _1043111279 图表目录 图 1 易 OA 总 体 关 系图 . 4 图 2 易 OA系 统 体 系 结 构 设计 . 4 图 3 易 OA 系统整体用例图 . 7 图 4 易 OA 系统登录用例实现 . 8 图 5 发布信息用例 . 9 图 6 还 书 登 记 用 例 实现 .13 / 17 .10 图 7 借书登记用例实现 . 11 图 8 刊 物更新用例实现 .12 图 9 设置个人信 息 及 签 名 用 例 实现 .13 图 10 设 置 权 限 用 例 实现 .13 1. 介绍 目的 这个软件设计文档给易 OA系统提供了开发时的详细设计，帮组开发人员了解整个系统的设计。易 OA 系统用于使企业内部人员方便快捷的共享信息，高效地办公协作，实现迅速、全方位的信息采集、信息处理。该系统采用 B/S 结构，摒弃以往 C/S 结构带来的消息阻塞或者来源匮乏。 范围 这个文档包含了易 OA 系统的详细设计。易 OA 系统主要是将数据库与各个 GUI 联系起来，对数据库进行一些必14 / 17 要的操作。系统使用 Java、 JSP、 SQL Server、 GUI 设计等开发。 该系统的系统管理员可以对数据库进行完全的操作，分配用户名、设置权限、增加或者删除员工信息、修改资料等都是由管理员操作。而该系统的主要使用者员工可以在系统的用户界面进行浏览信息、接受邮件、修改个人资料等。易 OA 系统主要针对企业内部的信息传递和文件管理，对其进行方便快捷操作。 术语表 参考资料 文档总览 这个文档余下的部分及其内容如下： 第二部分：系统概览描述了系统的一个最 基本的关系，并且介绍了项目 背景。 第三部分：体系结构设计描述了系统的整体结构，把系统所有的类联系 起来。并对系统的类进行类型说明、功能描述、输入输出项定义，使系统的结构与功能清楚的展现给开发人员。然后，对设计的基本原理进行阐述。 第四部分：数据结构设计描述了数据库的相关知识，对易 OA 系统的数 15 / 17 据结构设计进行详细的说明，表明其数据结构及其功能等。 第五部分：用例实现描述了系统的各个用例是怎样实现的，并且对实现 方法进行阐述。 第六部分：用户接口设计描述了用户接口的设计方法与易用性。 第七部分：资源估计描述开发易 OA 系统所需的硬件或软件的配备，比 如 CPU、硬盘容量、开发平台配置等。 2. 系统概览 该系统旨在开发一款可提高企业办公效率以及扩大员工知识的系统，它不仅可自动化办公，并且实现公司的信息发布、公告通知，而且可通过内部邮件收发来保证公司内部信息的保密性。该系统通过 Internet/Intranet 实现外部人员的浏览及公司员工的办公。 下图是该系统的一 个整体关系图， GUI、 server、Database 相互连接，将数据传递给用户。用户及管理员的所有操作都是基于数据库，然后通过服务器进行连接。 图 1 易 OA 总体关系图 3. 体系结构设计 结构描述 16 / 17 图 2 易 OA 系统体系结构设计 构件分解描述 名字： DatabaseConnect 类型： 类 描述： 这个类用于连接数据库，将系统的用户界面与数据库、服务器 连接起来，使用 sql 命令对数据库进行操作。 事件流： 用户运行易 OA 系统； 系统自动连接数据库； 数据库激活 名字： LoginPage 类型： 类 描述： 这个类用于登录易 OA 系统，对用户名与密码进行验证，如果正 确，进入系统主页；否则，显示错误信息。 事件流： 输入用户名和密码； 点击登录按钮； 进入系统主页 名字： UIInit 类型： 类 描述： 这个类用于对易 OA 系统界面初始化。 事件流： 初 始化界面 中的各个组件； 初始化界面 17 / 17 名字： PowerSet