详细设计说明书.docx
- 文档编号:10072916
- 上传时间:2023-05-23
- 格式:DOCX
- 页数:41
- 大小:810.19KB
详细设计说明书.docx
《详细设计说明书.docx》由会员分享,可在线阅读,更多相关《详细设计说明书.docx(41页珍藏版)》请在冰点文库上搜索。
详细设计说明书
会议管理系统
详细设计说明书
设计人:
李静
设计时间:
2014/3/26
详细设计说明书
1引言
1.1编写目的
本文档定义了Cool-Meeting系统的概要设计,使开发人员初步的了解Cool-Meeting系统的功能内容、功能边界、开发途径,运行环境等。
1.2背景
系统名称:
Cool-Meeting会议管理系统[以下简称CoolMeeting系统]
本项目是为了在一个公司内部,为员工提供高效、方便的会议预定服务及通知服务
而提出的,通过该系统可以清楚记录会议召开情况。
任务提出者:
某知名企业信息管理部门
开发者:
.net软件开发工程师
用户:
某知名企业员工
系统运行地点:
某知名企业内部
1.3定义
表1(采用英文命名)
缩写、术语
解释
CoolMeeting
会议管理系统的简称
User
CoolMeeting系统的用户角色
USERMN
CoolMeeting系统的用户管理模块
MeetingRoom
CoolMeeting系统的会议室管理模块
MeetingReserve
CoolMeeting系统的会议预定管理模块
Personal
CoolMeeting系统的个人中心管理模块
1.4参考资料
1.CoolMeeting会议管理系统需求说明书
2程序系统的结构
3机构和人员管理设计说明
机构和人员管理主要包括部门信息维护,员工注册,搜索员工,员工注册审批。
3.1部门信息维护程序描述
公司内部大约分成10个左右的部门,会议管理员负责这些部门信息的维护
3.1.1功能
3.1.2性能
要求个功能响应在5秒钟以内。
3.1.3输人项
增加新部门时,系统先在表示层收集部门数据,并实例化出实体类Model类Deparment(),将新部门信息所有属性封装进类Deparment(),然后通过方法传给Bll层,Bll层通过方法AddDepartment()把类Department传给Dal层,Dal层取出封装在类Department()里的属性值,直接用insertinto语句把信息插入到数据库中。
修改部门时,系统先在表示层收集用户数据,并实例化出实体类Model类Deparment(),将要修改的用户信息所有属性封装进类Department(),然后通过方法传给Bll层,Bll层通过方法UpdateDepartment()把类Department传给Dal层,Dal层取出封装在类Deparment()里的属性值,直接用Update语句把信息在数据库中修改。
删除部门信息时,系统先从表示层获取到要删除的用户ID,然后直接调用Bll层的DeleteDepartment()方法,该方法则把用户ID传给Dal层的DeleteDepartment()方法,在Dal层中直接执行delete语句,直接删除用户信息。
3.1.4输出项
部门信息管理的用例规约设计如下:
表4-1新建部门用例规约
用例名称:
建立新部门
用例ID:
FR-Department-1
角色:
管理员
用例说明:
管理员创建新部门
前置条件:
管理员已经登录CoolMeeting系统。
基本事件流:
1.管理员请求新建部门
2.CoolMeeting系统弹出部门信息管理页面。
3.管理员输入部门名称
4.点击“添加部门”按钮。
5.系统弹出系统用户信息页面。
6.系统保存部门信息,并提示添加部门成功。
其它事件流:
第3步,管理员输入的部门名称为必选项,如果没有填写,要给出提示信息
第6步,如果添加已有部门,则保存失败,给出提示信息:
“此部门已经存在”。
异常事件流:
第6步,系统保存部门时出现系统故障,例如网络故障,数据库服务器故障,系统弹出系统异常页面,提示管理员:
保存失败。
后置条件:
部门信息保存到数据库中,并在此页面下显示出刚刚创建的部门名称。
表4-2删除部门用例规约
用例名称:
删除部门
用例ID:
FR-Department-2
角色:
管理员
用例说明:
管理员删除部门。
前置条件:
管理员已经登录CoolMeeting系统。
基本事件流:
1.管理员请求删除部门。
2.管理员选中要删除的单个部门,并选择“删除”。
3.CoolMeeting系统弹出删除确认提示。
4.系统弹出提出信息:
是否要删除?
管理员选择确定。
5.系统删除选中的系统用户,并更新系统用户列表。
其它事件流:
第4,管理员选择取消,则取消删除操作。
异常事件流:
第5,系统删除部门时出现系统故障,例如网络故障,数据库服务器故障,系统弹出系统异常页面,提示管理员:
删除失败。
后置条件:
系统删除部门信息。
表4-4更新部门用例规约
用例名称:
更新部门
用例ID:
FR-Department-3
角色:
管理员
用例说明:
管理员更新部门信息
前置条件:
管理员已经登录CoolMeeting系统。
基本事件流:
1.User请求更新部门信息。
2.管理员选中要更新的单个部门,并选择“编辑”。
3.管理员对选中的部门名称进行编辑
4.管理员点击更新。
5.系统提示更新成功
6.系统保存系统用户信息,并返回更新的用户信息。
其它事件流:
无
异常事件流:
第6步,系统保存更新的部门信息时出现系统故障,例如网络故障,数据库服务器故障,系统弹出系统异常页面,提示管理员:
保存失败。
后置条件:
系统更新部门信息。
3.1.5算法
对于本软件,采用数据的输入输出与sql数据库链接等基本算法。
3.1.6流程逻辑
3.1.7接口
本模块与其他模块之间根据DepartmentID平行连接
3.1.8存储分配
无特别存储分配的需要
3.1.9注释设计
程序说明性注释
3.1.10限制条件
本模块在运行使用中无特别的限制条件
3.1.11测试计划
本模块针对部门信息,在测试时要求对测试输入数据到数据库,同时在外部查询时能准确的查询出数据。
3.1.12尚未解决的问题
无
3.2员工注册程序描述
本系统要求员工个人在网站上自行注册,通过审批后方可登录访问。
任何员工都可以进行注册。
3.2.1功能
3.2.2性能
要求个功能响应在5秒钟以内。
3.2.3输人项
员工注册时,系统先在表示层收集部门数据,并实例化出实体类Model类Employee(),将新部门信息所有属性封装进类Employee(),然后通过方法传给Bll层,Bll层通过方法AddEmployee()把类Employee传给Dal层,Dal层取出封装在类Employee()里的属性值,直接用insertinto语句把信息插入到数据库中。
3.2.4输出项
员工注册管理的用例规约设计如下:
表4-1员工注册用例规约
用例名称:
注册新员工
用例ID:
FR-Employee-1
角色:
Employee和管理员
用例说明:
员工注册
前置条件:
无
基本事件流:
1.employs请求注册
2.CoolMeeting系统弹出员工信息添加页面。
3.员工输入姓名、账户名、密码及确认密码、所属部门、联系电话、电子邮件信息
4.点击“提交”按钮。
5.系统保存部门信息,并提示添加部门成功。
其它事件流:
第3步,管理员输入的信息为必选项,如果没有填写,要给出提示信息
第5步,如果添加已有用户名或电子邮件,则保存失败,给出提示信息:
“已有用户名或电子邮件,请修改”。
异常事件流:
第5步,系统处理员工注册时出现系统故障,例如网络故障,数据库服务器故障,系统弹出系统异常页面,提示用户:
注册失败。
后置条件:
员工信息保存到数据库中,提示注册成功。
3.2.5算法
对于本软件,采用数据的输入输出与sql数据库链接等基本算法。
3.2.6流程逻辑
3.2.7接口
本模块与其他模块之间根据EmployeeID平行连接
3.2.8存储分配
无特别存储分配的需要
3.2.9注释设计
程序说明性注释
3.2.10限制条件
本模块在运行使用中无特别的限制条件
3.2.11测试计划
本模块针对员工注册的信息,在测试时要求对测试输入数据到数据库,同时在外部查询时能准确的查询出数据。
3.2.12尚未解决的问题
无
3.3搜索员工程序描述
每个员工(账号)的状态为下列几种之一:
*待审批。
该员工已注册,但还没有通过审批
*已批准。
该员工的注册已经通过审批,可以正常使用系统功能
*已关闭。
该员工已经离职,其账号信息不再使用
搜索员工操作包括:
*根据真实姓名、账号名及员工状态综合搜索员工信息,其中姓名和账号名允许模糊搜索
*搜索结果以分页形式展现
*搜索出的员工状态为”待审批”时,可以直接审批或删除该员工
*搜索出的员工状态为”已审批”时,可以关闭该员工
*搜索出的员工状态为”已关闭”时,不能执行其它操作
业务规则包括:
*一旦状态置为“已关闭”,则不可还原
3.3.1功能
3.3.2性能
要求个功能响应在5秒钟以内。
3.3.3输人项
搜索用户信息时,系统先从表示层获取要查询的用户的ID,然后直接调用Bll层的GetEmployeeByUserName()方法,该方法把用户ID传给Dal层的SearchEmployeeByUserName()方法,在Dal层中直接执行select语句,并把返回的表返回给表示层,显示给用户。
3.3.4输出项
搜索员工管理的用例规约设计如下:
表4-1搜索员工用例规约
用例名称:
搜索员工
用例ID:
FR-Employee-2
角色:
管理员
用例说明:
员工搜索
前置条件:
管理员已经登录CoolMeeting系统。
基本事件流:
1.管理员请求搜索员工详细信息。
2.CoolMeeting系统弹出员工信息查询页面。
3.管理员输入姓名或账号名
4.系统根据姓名或账号名弹出对话框显示此系统用户的详细信息,包括姓名,用户名,所属部门,联系电话和电子邮件等。
其它事件流:
第3步,输入不存在的姓名或账号名,则提示没有搜索到满足条件的记录!
异常事件流:
第4步,系统搜索员工时出现系统故障,例如网络故障,数据库服务器故障,系统弹出系统异常页面,提示用户:
搜索失败。
后置条件:
在此页面下显示出搜索到的员工信息。
3.3.5算法
对于本软件,采用数据的输入输出与sql数据库链接等基本算法。
3.3.6流程逻辑
3.3.7接口
本模块与其他模块之间根据EmployeeID平行连接
3.3.8存储分配
无特别存储分配的需要
3.3.9注释设计
程序说明性注释
3.3.10限制条件
本模块在运行使用中无特别的限制条件
3.3.11测试计划
本模块针对员工的信息,在测试时要求对测试输入数据到数据库,同时在外部查询时能准确的查询出数据。
3.3.12尚未解决的问题
无
3.4员工注册审批程序描述
员工注册后,还需要通过审批,账号才能使用。
会议管理员负责所有员工账号的审批。
审批操作包括:
*列出所有待审批员工注册信息
*审批单个员工注册信息
*对于不合格的注册信息,可以直接删除
3.4.1功能
3.4.2性能
要求个功能响应在5秒钟以内。
3.4.3输人项
审批时,合格的注册信息标记为Pass,否则删除该注册用户,删除用户信息时,系统先从表示层获取到要删除的用户ID,然后直接调用Bll层的DeleteEmployee()方法,该方法则把用户ID传给Dal层的DeleteEmployee()方法,在Dal层中直接执行delete语句,直接删除用户信息。
3.4.4输出项
注册审批管理的用例规约设计如下:
表4-1注册审批用例规约
用例名称:
注册审批
用例ID:
FR-Employee-3
角色:
管理员
用例说明:
注册审批
前置条件:
管理员已经登录CoolMeeting系统。
基本事件流:
1.管理员请求审批注册员工信息。
2.CoolMeeting系统弹出所有待审批员工信息页面。
3.管理员审批,合格点击通过按钮,不合格点击删除按钮
4.通过提示审批成功,删除则弹出是否确认删除框
其它事件流:
第4步,若删除此用户时点击取消,则返回待审批员工信息页面
异常事件流:
第4步,系统审批注册员工时出现系统故障,例如网络故障,数据库服务器故障,系统弹出系统异常页面,提示用户:
审批失败。
后置条件:
审批成功的用户可以进行登录
3.4.5算法
对于本软件,采用数据的输入输出与sql数据库链接等基本算法。
3.4.6流程逻辑
3.4.7接口
本模块与其他模块之间根据EmployeeID平行连接
3.4.8存储分配
无特别存储分配的需要
3.4.9注释设计
程序说明性注释
3.4.10限制条件
本模块在运行使用中无特别的限制条件
3.4.11测试计划
本模块针对审批员工的注册信息,在测试时要求对测试输入数据到数据库,同时在外部查询时能准确的查询出数据。
3.4.12尚未解决的问题
无
4会议室管理设计说明
会议室是会议预定的核心资源。
会议管理员负责维护会议室的信息。
包括添加会议室和修改会议室信息。
4.1添加会议室程序描述
会议室信息包括:
门牌号、名称、容量、状态、备注。
其中:
*容量是指会议室最多能容纳的人数。
系统将根据此容量来匹配会议预定申请。
*会议室状态包括:
启用、停用和删除。
会议室添加成功后默认是启用状态,维修时处于停用状态,删除则是指该会议室再也不被使用。
业务规则包括:
*会议室门牌号必须唯一,不超过10个字符。
例如101,203等。
*除了门牌号,会议室还可以提供一个便于记忆的名称,例如:
综合会议室、第一会议室等等。
名称必须唯一,且不超过20个字符。
*只有“启用”状态的会议室才能预定;“删除”的会议室将不能再被启用;暂时“停用”的会议室可以被重新启用。
*备注不超过200字符,可以不填。
4.1.1功能
4.1.2性能
要求个功能响应在5秒钟以内。
4.1.3输人项
增加会议室时,系统先在表示层收集会议室数据,并实例化出实体类Model类MeetingRoom(),将会议室信息所有属性封装进类MeetingRoom(),然后通过方法addMeetingRoom()传给Bll层,Bll层通过方法addMeetingRoom()把类MeetingRoom传给Dal层,Dal层取出封装在类MeetingRoom()里的属性值,直接用insertinto语句把信息插入到数据库中。
4.1.4输出项
增加会议室的用例规约设计如下:
表4-5建立新会议室用例规约
用例名称:
建立新会议室
用例ID:
FR-MeetingRoom-1
角色:
管理员
用例说明:
管理员创建新会议室。
前置条件:
管理员已经登录CoolMeeting系统。
基本事件流:
1.管理员请求新建会议室
2.CoolMeeting系统弹出会议室信息添加页面。
3.管理员输入门牌号、会议室名称、最多容纳人数、当前状态、备注等信息
4.点击确定按钮
5.系统保存会议室信息,并返回新增的会议室信息。
其它事件流:
第4步,User输入项为必选项,如果某一项没有填写,要给出提示信息。
备注为非必选项。
第3步,管理员输入的入库单信息不符合格式要求,系统给出提示信息,要求重新输入。
第5步,会议室ID自动生成。
异常事件流:
第5步,系统保存会议室信息时出现系统故障,例如网络故障,数据库服务器故障,系统弹出系统异常页面,提示管理员:
保存失败。
后置条件:
会议室信息保存到数据库中
4.1.5算法
对于本软件,采用数据的输入输出与sql数据库链接等基本算法。
4.1.6流程逻辑
4.1.7接口
本模块与其他模块之间根据MeetingRoomID平行连接
4.1.8存储分配
无特别存储分配的需要
4.1.9注释设计
程序说明性注释
4.1.10限制条件
本模块在运行使用中无特别的限制条件
4.1.11测试计划
本模块针对会议室的信息,在测试时要求对测试输入数据到数据库,同时在外部查询时能准确的查询出数据。
4.1.12尚未解决的问题
无
4.2修改会议室信息程序描述
会议管理员可以修改会议室信息。
操作包括:
*以分页列表方式浏览所有会议室信息
*选择要修改的会议室,查看其详细信息
*修改会议室门牌号、名称、容量、状态、备注信息
4.2.1功能
4.2.2性能
要求个功能响应在5秒钟以内。
4.2.3输人项
修改会议室时,系统先在表示层收集会议室数据,并实例化出实体类Model类MeetingRoom(),将新会议信息所有属性封装进类MeetingRoom(),然后通过方法updateMeetingRoom()传给Bll层,Bll层通过方法updateMeetingRoom()把类MeetingRoom传给Dal层,Dal层取出封装在类MeetingRoom()里的属性值,直接用update语句把信息插入到数据库中。
4.2.4输出项
修改会议室的用例规约设计如下:
表4-5修改会议室用例规约
用例名称:
修改会议室信息
用例ID:
FR-MeetingRoom-2
角色:
管理员
用例说明:
修改会议室信息。
前置条件:
管理员已经登录CoolMeeting系统。
基本事件流:
1.管理员请求修改会议室
2.管理员选中要更新的单个部门,并选择“编辑”。
3.管理员对选中的部门信息进行编辑
4.管理员点击更新。
5.系统提示更新成功
6.系统保存会议室信息,并返回更新的会议室信息。
其它事件流:
第4步,管理员输入项为必选项,如果某一项没有填写,要给出提示信息。
备注为非必选项。
第3步,管理员输入的入库单信息不符合格式要求,系统给出提示信息,要求重新输入。
第5步,会议室ID自动生成。
异常事件流:
第6步,系统保存会议室信息时出现系统故障,例如网络故障,数据库服务器故障,系统弹出系统异常页面,提示管理员:
保存失败。
后置条件:
会议室信息保存到数据库中
4.2.5算法
对于本软件,采用数据的输入输出与sql数据库链接等基本算法。
4.2.6流程逻辑
4.2.7接口
本模块与其他模块之间根据EmployeeID平行连接
4.2.8存储分配
无特别存储分配的需要
4.2.9注释设计
程序说明性注释
4.2.10限制条件
本模块在运行使用中无特别的限制条件
4.2.11测试计划
本模块针对新建会议室的信息,在测试时要求对测试输入数据到数据库,同时在外部查询时能准确的查询出数据。
4.2.12尚未解决的问题
无
5会议预定设计说明
会议预定是被系统的核心业务功能。
包括预定会议,更改会议预定和撤销会议预定。
5.1预定会议程序描述
所有员工都可以预定会议。
预定会议时需要填写会议信息。
会议信息包括:
*基本信息:
会议名称、预计参会人数、会议起止时间、会议说明、会议预定者
*参会人员:
从注册员工中选择确定要参加此次会议的人员。
业务规则包括:
*所有会议必须至少提前1小时预定
*预订者提供会议基本信息,参会人员信息,选定会议室后,系统根据预计参会人数和会议起止时间信息,判断选定的会议室是否合乎条件。
如果不合条件,应提示用户重新选择
*如果没有满足要求的会议室,则提示预定者更改条件会议信息
*会议的预定者不一定会参加会议
*会议说明在200字以内,可以不填
5.1.1功能
5.5.1.2性能
要求个功能响应在5秒钟以内。
5.1.3输人项
预定会议时,系统先在表示层收集会议数据,并实例化出实体类Model类Meeting(),将新会议信息所有属性封装进类Meeting(),然后通过方法addMeeting()传给Bll层,Bll层通过方法addMeeting()把类Meeting传给Dal层,Dal层取出封装在类Meeting()里的属性值,直接用insertinto语句把信息插入到数据库中。
5.1.4输出项
预定会议的用例规约设计如下:
表4-5建立新入库单用例规约
用例名称:
预定会议
用例ID:
FR-Meeting-1
角色:
Employee
用例说明:
Employee预定会议
前置条件:
Employee已经登录CoolMeeting系统
基本事件流:
1.employee请求预定会议。
2.CoolMeeting系统弹出预定会议信息页面。
3.输入会议会议名称、预计参加人数、预计开始时间、预计结束时间、选择会议室、会议说明、选择参会人员,点击预定会议按钮
4.系统保存预定会议信息
其它事件流:
第3步,employee输入项为必选项,如果某一项没有填写,要给出提示信息。
第3步,输入的会议信息不符合格式要求,系统给出提示信息,要求重新输入。
第4步,会议ID自动生成。
异常事件流:
第4步,系统保存预定会议信息时出现系统故障,例如网络故障,数据库服务器故障,系统弹出系统异常页面,提示:
保存失败。
后置条件:
预定会议信息保存到数据库中,并在会议信息查询页面显示出刚刚预定的会议。
5.1.5算法
对于本软件,采用数据的输入输出与sql数据库链接等基本算法。
5.1.6流程逻辑
5.1.7接口
本模块与其他模块之间根据MeetingID平行连接
5.1.8存储分配
无特别存储分配的需要
5.1.9注释设计
程序说明性注释
5.1.10限制条件
本模块在运行使用中无特别的限制条件
5.1.11测试计划
本模块针对预定的会议信息,在测试时要求对测试输入数据到数据库,同时在外部查询时能准确的查询出数据。
5.1.12尚未解决的问题
无
5.2更改会议程序描述
本系统不支持更改会议预定。
预定者只能先撤销会议预定,然后再重新预定会议
5.3撤销会议预定程序描述
会议的预定者可以撤销会议预定,按照下列规则进行:
*撤销预定可以发生在在会议开始前的任何时间
*撤销预定时,需要填写200字以内的撤销理由
业务规则如下:
*会议撤销后,需要通知相关人员(见“个人中心”中的“最新通知”)
5.3.1功能
5.3.2性能
要求个功能响应在5秒钟以内。
5.3.3输人项
撤销会议时,系统先在表示层收集会议数据,并实例化出实体类Model类Meeting(),将会议信息所有属性封装进类Meeting(),然后通过方法deleteMeeting()传给Bll层,Bll层通过方法deleteMeeting()把类Meeting传给Dal层,Dal层取出封装在类Meeting()里的属性值,直接用delete语句把信息插入到数据库中。
5.3.4输出项
撤销会议的用例规约设计如下:
表4-5撤销会议用例规约
用例名称:
撤销会议
用例ID:
FR-Meeting-2
角色:
Empl
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 详细 设计 说明书