详细设计说明书——教室管理系统(查询与申请)

详细设计说明书
项目名称教室管理系统（查询与申请）项目开发单位XXXXXXXXXXXXXX
项目开发人员XXX
1．引言 (1)
1.1 项目说明 (1)
1.2 项目定义 (1)
1.3 编写目的 (1)
1.4 参考资料 (1)
2．总体设计 (2)
2.1软件结构 (2)
2.2需求概述 (2)
3．程序描述 (2)
3.1系统组成 (2)
3.2模块详细设计 (3)
3.3接口设计 (8)
4．测试计划 (9)
4.1测试目的 (9)
4.2测试要点 (9)
4.3测试方法 (9)
1．引言
1.1 项目说明
项目名称：教室信息管理系统
项目提出单位：12级电子信息工程一班
项目开发人员：李洁
文档审核者：刘超群
1.2 项目定义
教室信息管理系统是为了适应现代化学院管理的需要，加快推进我院网络教学建设、充分利用校园网，利用网络、多媒体等计算机应用技术和手段，提高办公效率、改善质量的高效管理信息系统。

教室信息管理系统是学院信息管理系统的重要组成部分。

1.3 编写目的
本文档为《教室信息管理系统（申请与查询）详细设计说明书》，主要用于为实现系统的功能而进行的系统详细设计说明，详细系统各软件组成模块的实现流程、功能、接口、编译等内容，便于对系统的编码进行指导和约束。

本文档供项目组全体成员及项目组领导，单元测试人员阅读。

1.4 参考资料
[1]软件开发人员.软件需求分析报告，2014.10
[2]软件开发人员.软件概要设计说明书，2014.11
[3]张海藩.软件工程导论.第五版.北京：清华大学出版社，2008.2
[4]陶宏才.数据库原理及设计.第1版.北京.清华大学出版社，2004.2
[5]肖刚等.实用软件文档写作.北京：清华大学出版社，2005.2
2．总体设计
2.1软件结构
直观地描述了学院信息管理系统、教室信息管理系统、各功能模块之间的从属关系。

如图2.1所示。

图2.1 程序系统结构图
2.2需求概述
按照需求分析报告中的要求，用户可分为管理员和非管理员用户两类：管理员可完成对教室信息的录入、修改、删除、查询及审核申请等操作；非管理员用户则只能进行教室的查询和申请等操作。

同时，系统最大限度地实现易维护性，易操作性，运行稳定，安全可靠。

3．程序描述
3.1系统组成
本系统由4大模块，7小模块组成。

如表3.1所示。

表3.1 各模块之间的关系
3.2模块详细设计
1、用户登录模块
（1）功能流程图：
用户登录模块中数据处理流程的具体描述，如图3.1所示。

图3.1 登录流程图说明：
①录入项检测使用javascript实现（各项必须非空）
②登陆.jsp页面提交的数据只是用户名和密码
（2）功能描述
功能类型：查询数据
功能描述：提高系统的安全性
前提业务：无
后继业务：02（管理模块）、03（查询模块）、04（申请模块）操作权限：用户
（3）伪代码
class User{
在文本框处输入用户名和密码
if 用户登录{
if admin{
switch(r){
case 0:inputs(classroom); //添加教室
case 1:delete(classroom); //删除教室
case 2:update(classroom); //修改教室
case 3:lookfor(classroom); //查询教室
case 4:checkapp(classroom); //审核申请
}
}
else otheruser{
switch(r){
case 3:lookfor(classroom); //查询教室
case 5:apply(classroom); //申请教室
}
}
}
else NULL{
System.out.println(＂密码错误或不存在该用户＂);
}
}
2、教室管理模块
（1）功能流程图
教室管理模块中数据处理流程的具体描述，如图3.2所示。

图3.2 教室管理流程图
说明：
①选择相应的操作时均在当前的页面显示
②在教室管理.jsp页面内，默认显示教室查询.jsp页面
（2）功能描述
功能类型：其他
功能描述：总体归纳教室管理功能
前提业务：01（登录模块）
后继业务：无
操作权限：系统管理员
（3）伪代码
class ClassroomManage {
if admin{
switch(r){
case 0:inputs(classroom); //添加教室
case 1:delete(classroom); //删除教室
case 2:update(classroom); //修改教室
case 3:lookfor(classroom); //查询教室
}
}
lookfor(classroom){
在下拉菜单中选择教室编号或在文本框处输入教室编号或教学楼编号;
}
inputs(classroom){
在文本框处输入教室编号、教学楼编号、使用状态、类型和容量;
if 信息不完整{
System.out.println(＂请输入完整信息＂);
}
}
delete(classroom){
在文本框处输入教室编号或使用状态;
删除选中的教室;
}
update(classroom){
在文本框处输入教室编号;
在显示的页面文本框中输入相应的修改信息;
}
}
3、教室查询模块
（1）功能流程图
教室查询模块中数据处理流程的具体描述，如图3.3所示。

图3.3 教室查询流程图
说明：
①录入项检测使用javascript来实现（各项非空）
（2）功能描述
功能类型：查询数据
功能描述：显示教室信息，包括教室编号、教学楼编号、容量、类型、使用状态前提业务：无
后继业务：02（教室管理）、04（教室申请）
操作权限：面向所有用户
（3）伪代码
class ClassroomCheck{
lookfor(classroom){
在下拉菜单中选择教室编号或在文本框处输入教室编号或教学楼编号;
在显示的页面显示查询结果;
}
}
4、教室申请模块
（1）功能流程图
教室申请模块中数据处理流程的具体描述，如图3.4所示。

图3.4 教室申请流程图
说明：
①非管理员用户在该模块中可申请教室和查看申请是否通过审核
②管理员审核申请。

若通过，则修改修改教室.jsp的相应信息；否则，返回“不通过”到教室申请信息.jsp页面
（2）功能描述
功能类型：查询数据和修改数据
功能描述：更新教室申请信息等文件中的信息
前提业务：无
后继业务：无
操作权限：面向所有用户，但用户使用功能不同
（3）伪代码
class ClassroomApply{
if otheruser{
在教室申请表中各个文本框处输入相应信息;
提交申请;
}
else {
显示教室申请表；
if pass{
update(classroom){
在文本框处输入教室编号;
在显示的页面文本框中输入相应的修改信息;
}
}
else{
System.out.println(＂不通过＂);
}
}
}
3.3接口设计
（1）用来查询一条数据的私有接口
（2）增加记录的公共接口
（3）删除记录的公共接口
（4）查询记录的公共接口
（5）修改记录的接口
4．测试计划
4.1测试目的
①测试教室信息管理系统（申请与查询）的各种功能是否含有BUG
②能否正常运行该系统，包括添加教室、删除教室等操作
③预期达到能够在系统投入运行之前进可能的找出系统的错误
4.2测试要点
（1）用户登录验证
主要内容：验证用户身份，进行权限控制
简要说明：功能性测试
（2）教室查询功能测试
主要内容：测试代码的健壮性
简要说明：功能性测试
（3）教室管理功能测试
主要内容：测试代码的健壮性
简要说明：功能性测试
（4）教室申请功能测试
主要内容：测试代码的健壮性
简要说明：功能性测试
4.3测试方法
功能性测试：黑盒测试
第9页。