——用例说明文档
1项目文档的信息
1.1 项目名称及目的
项目名称:考研网上辅导系统
项目目的:(1)满足当下研究生的学习需求;
(2)增加学习效率;
(3)为想考研的同学提供一个使用方便的平台;
(4) 有利于跨考学生对信息的及时获取
1.2 文档编写目的及内容概述
编写本文档是为了加深考研网上辅导系统开发者对系统的理解,明确系统功能,更好地理解客户需求,做出客户满意的软件产品。与此同时,通过用例驱动可以为我们良好的软件结构设计打下基础。此文档,也供用户,需求分析人员,设计人员,测试人员和任何其他涉及系统的人员阅读,帮助他们更好地了解此项目。这个用例文档可作为分析人员、设计人员和测试人员的资料,进行用例的分析、设计及相关测试。
我们使用面向对象分析的方法,认为系统是对象的集合,这些对象之间相互协作,共同完成系统的任务。考研网上辅导系统的参与者有普通用户(学生)和管理员。普通用户的任务有修改个人信息,发表文章、评论、下载学习资料;管理员的任务有管理用户、文章、资料,数据库维护。这些是系统的用例分析,在文档第二、三部分,有对其细化。
1.3 文档组织结构
文档分为三个部分,为了方便开发者后续阶段的使用及读者阅读,我们对每一个部分都做了标号。第一部分简介本文档和本项目;第二部分主要是用例图和少量的文字;第三部分主要是用例描述,为了使描述规范化,我们采用了统一的模板进行描述。
1.4 文档约定
对本文档的任何变动都应经过小组讨论,并且每次发生变动都应记录变动内容。
1.5 文档编写人员
本文档由中南林业科技大学涉外学院2019级软工九班姚永天完成。
1.6 参考文献
[1]杨长春.软件需求分析实战.清华大学出版社.2021.
[1] 骆斌,丁二玉.需求工程——网页建模与分析[M].高等教育出版社,2009.
[2] Mark.Priestley.面向对象设计UML实践[M].清华大学出版社,2014.
[3]曹锦芳.2001.信息系统分析与设计.北京:北京航空航天大学出版社
[4]吴键,郑潮,汪杰.UML基础与Rose建模案例(第2版).北京:人民邮电出版社,2007
[5]胡方霞.基于UML的面向对象分析方法[J].四川兵工学报.2004年02期.31-33
[6]计算机软件需求规格说明规范(GT/T 9538-2008)
[7]曹锦芳.2001.信息系统分析与设计.北京:北京航空航天大学出版社.
2.用例图
普通用户可以查看文章、学习视频资源、下载学习资源等。
信息,管理用户信息,维护数据库。
图2.1 考研网上辅导系统的用例图
- 用例描述
用例DC1:
对用例DC1的详细描述,描述的方式如下表所述。
ID: | DC1 |
名称: | 普通用户注册 |
用例属性 | 创建者:;创建日期:2021-12-18 |
参与者: | 主要参与者:学生。 目标:在登录系统前必须要完成的信息。 |
描述: | 任何运行考研网上辅导系统的用户都需要进行登录。登录时用户需要输入用户账号名和密码,若是用户没有账号,需要注册账号。 |
优先级: | 十分重要 |
触发条件: | 考研网上辅导系统服务器已经打开,用户已经注册登录。 |
前置条件: | 用户已经注册登录 |
后置条件: | 注册成功,显示登录界面 |
正常流程: | 1.用户在系统选择注册功能 2.用户在注册界面按要求输入注册信息 3.注册界面审核注册信息确定注册成功 |
分支流程: | 无 |
异常流程: | 无 |
相关用例: | DC2、DC3、DC4、DC5、DC6、DC7 |
业务规则: | 顾客可能需要更多软件不包含的信息,使得其放弃查看软件选择人工服务 |
特殊需求: | 系统切换显示界面的响应时间小于0.5秒 |
假设: | 客户端的终端机为浏览器,PC端、移动端设备已准备,网页可基于开发 |
待确定问题: | 无 |
用例DUC2:
对用例DC2的详细描述,描述的方式如下表所述。
ID: | DC2 |
名称: | 普通用户登录 |
用例属性 | 创建者:;创建日期:2021-12-18 |
参与者: | 主要参与者:学生 目标:在执行所有工作之前必须要完成的信息。 |
描述: | 任何运行考研网上辅导系统的用户在执行所有工作之前都需要进行登录。登录时用户需要输入用户账号名和密码。系统对用户登录信息进行确认。系统确认信息正确后,跳转到系统主界面,登录成功。 |
优先级: | 十分重要 |
触发条件: | 考研网上辅导系统服务器已经打开 |
前置条件: | 系统用户运行考研网上辅导系统,并已经注册成功。 |
后置条件: | 登录成功,显示系统查看界面 |
正常流程: | 1.用户在系统选择登录功能 2.用户在登录界面输入用户账号名和密码 3.登录界面审核登录信息确定登录成功 |
分支流程: | 可能分支在正常流程的2处: 3.用户不想继续完成功能,选择返回 4.系统返回到原界面 |
异常流程: | 无 |
相关用例: | DC1、DC3、DC4、DC5、DC6、DC7 |
业务规则: | 用户可能需要更多软件不包含的信息,使得其放弃查看软件选择人工服务 |
特殊需求: | 系统切换显示界面的响应时间小于0.5秒 |
假设: | 客户端的终端机为浏览器,PC端、移动端设备已准备,网页可基于开发 |
待确定问题: | 无 |
用例DC3:
对用例DC3的详细描述,描述的方式如下表所述。
ID: | DC3 |
名称: | 查看网站主界面 |
用例属性 | 创建者:;创建日期:2021-12-18 |
参与者: | 主要参与者:学生 目标:查看网站主界面。 |
描述: | 用户登陆系统后进入主界面,可以看到考研相关的文章,学习视频,资料等栏目内容,用户可以在右上角查看自己的登录信息。 |
优先级: | 重要 |
触发条件: | 考研信息管理功能之一 |
前置条件: | 用户登录系统成功,并选择查看考研相关栏目。 |
后置条件: | 浏览器显示主界面 |
正常流程: | 1.用户登录成功后,跳转到网站主界面 2.用户在主界面查看所有的功能信息 3.用户选中某个栏目进入不同栏目界面 4.在不同的栏目界面可以查看这个栏目的所有信息。 |
分支流程: | 可能分支在正常流程的2处: 1.用户不想继续完成功能,选择返回 2.浏览器返回到原界面 |
异常流程: | 无 |
相关用例: | DC1、DC2、DC4、DC5 |
业务规则: | 用户可能需要更多软件不包含的信息,使得其放弃查看软件选择人工服务 |
特殊需求: | 系统切换显示界面的响应时间小于0.5秒 |
假设: | 客户端的终端机为浏览器,PC端、移动端设备已准备,网页可基于开发 |
待确定问题: | 无 |
用例DC4:
对用例DC4的详细描述,描述的方式如下表所述。
ID: | DC4 |
名称: | 查看文章 |
用例属性 | 创建者:;创建日期:2021-12-18 |
参与者: | 主要参与者:学生 目标:查看文章。 |
描述: | 用户登录系统后,可以在主界面选择文章栏目,首页会显示文章的标题,用户点击标题后会跳转到文章详细页面,在此页面用户可以评论。 |
优先级: | 重要 |
触发条件: | 考研网上辅导系统服务器已经打开,用户已经打开网站。 |
前置条件: | 用户登录系统成功,并选择查看文章功能。 |
后置条件: | 系统显示文章信息 |
正常流程: | 1.顾客登录成功后,跳转到主界面。 2.顾客在主界面查看文章,选择自己要看的文章 3.在选择的文章信息界面,可以进行评论 |
分支流程: | 可能分支在正常流程的2处: 3.用户不想继续完成功能,选择返回 4.系统返回到原界面 |
异常流程: | 无 |
相关用例: | DC1、DC2、DC3、DC5、DC7 |
业务规则: | 用户可能需要更多软件不包含的信息,使得其放弃查看软件选择人工服务 |
特殊需求: | 系统切换显示界面的响应时间小于0.5秒 |
假设: | 客户端的终端机为浏览器,PC端、移动端设备已准备,网页可基于开发 |
待确定问题: | 无 |
用例DC5:
对用例DC5的详细描述,描述的方式如下表所述。
ID: | DC5 |
名称: | 查看视频信息 |
用例属性 | 创建者:;创建日期:2021-12-18 |
参与者: | 主要参与者:用户 目标:查看视频信息。 |
描述: | 用户登录系统后,可以在主界面选择视频栏目,首页会显示视频的标题,用户点击标题后会跳转到视频详细页面,在此页面用户可以观看视频及评论。 |
优先级: | 普通 |
触发条件: | 考研网上辅导系统服务器已经打开,用户已经打开网站。 |
前置条件: | 用户登录系统成功,并选择查看视频功能。 |
后置条件: | 系统显示所有视频信息 |
正常流程: | 1.用户登录成功后,跳转到主界面。 2.用户在主界面查看文章,选择自己要看的视频 3.在选择的视频信息界面,可以进行查看及下载 |
分支流程: | 可能分支在正常流程的2处: 3.用户不想继续完成功能,选择返回 4.系统返回到原界面 |
异常流程: | 无 |
相关用例: | DC1、DC2、DC3、DC4、DC7 |
业务规则: | 用户可能需要更多软件不包含的信息,使得其放弃查看软件选择人工服务 |
特殊需求: | 系统切换显示界面的响应时间小于0.5秒 |
假设: | 客户端的终端机为浏览器,PC端、移动端设备已准备,网页可基于开发 |
待确定问题: | 无 |
用例DC6:
对用例DC6的详细描述,描述的方式如下表所述。
ID: | DC6 |
名称: | 查看资料信息 |
用例属性 | 创建者:;创建日期:2021-12-18 |
参与者: | 主要参与者:用户 目标:查看资料信息。 |
描述: | 用户登录系统后,可以在主界面选择资料栏目,首页会显示资料的标题,用户点击标题后会跳转到资料详细页面,在此页面用户可以查看资料及评论。 |
优先级: | 普通 |
触发条件: | 考研网上辅导系统服务器已经打开,用户已经打开网站。 |
前置条件: | 用户登录系统成功,并选择查看资料功能。 |
后置条件: | 系统显示所有资料信息 |
正常流程: | 1.用户登录成功后,跳转到主界面。 2.用户在主界面查看文章,选择自己要看的资料 3.在选择的资料信息界面,可以进行查看及下载 |
分支流程: | 可能分支在正常流程的2处: 3.用户不想继续完成功能,选择返回 4.系统返回到原界面 |
异常流程: | 无 |
相关用例: | DC1、DC2、DC3、DC4、DC7 |
业务规则: | 用户可能需要更多软件不包含的信息,使得其放弃查看软件选择人工服务 |
特殊需求: | 系统切换显示界面的响应时间小于0.5秒 |
假设: | 客户端的终端机为浏览器,PC端、移动端设备已准备,网页可基于开发 |
待确定问题: | 无 |
用例DC7:
对用例DC7的详细描述,描述的方式如下表所述。
ID: | DC6 |
名称: | 修改用户密码 |
用例属性 | 创建者:;创建日期:2021-12-18 |
参与者: | 主要参与者:用户 目标:对密码的修改。 |
描述: | 普通用户登录系统后想修改密码,可以在修改密码界面进行修改,确认后,会提示密码修改成功,并返回到主界面。 |
优先级: | 普通 |
触发条件: | 资料考研网上辅导系统服务器已经打开,用户已经打开网站。 |
前置条件: | 普通用户运行考研网上辅导系统,并登录系统。 |
后置条件: | 密码修改成功 |
正常流程: | 1. 顾客登录成功后,跳转到主界面。 2. 右上角显示“个人信息”功能 3.进入修改密码界面,按步骤对密码进行修改。 4.修改完成后确定 5、提示密码修改成功,并返回主界面 |
分支流程: | 可能分支在正常流程的2处: 3.用户不想继续完成功能,选择返回 4.系统返回到原界面 |
异常流程: | 无 |
相关用例: | DC1、DC2 |
业务规则: | 用户可能需要更多软件不包含的信息,使得其放弃查看软件选择人工服务 |
特殊需求: | 系统切换显示界面的响应时间小于0.5秒 |
假设: | 客户端的终端机为浏览器,PC端、移动端设备已准备,网页可基于开发 |
待确定问题: | 无 |
用例DC8:
对用例DC8的详细描述,描述的方式如下表所述。
ID: | DC8 |
名称: | 管理员登录 |
用例属性 | 创建者:;创建日期:2021-12-18 |
参与者: | 主要参与者:管理员 目标:在执行所有工作之前必须要完成的信息。 |
描述: | 管理员在执行所有工作之前都需要进行登录。登录时需要输入登录名和密码。系统对管理员登录信息进行确认。系统确认信息正确后,跳转到系统管理主界面,登录成功。 |
优先级: | 十分重要 |
触发条件: | 考研网上辅导系统服务器已经打开 |
前置条件: | 管理员登录系统界面 |
后置条件: | 登录成功,显示系统管理界面 |
正常流程: | 1.管理员启动浏览器,在地址栏输入服务器的端口地址,进入管理员登录界面。 2.在登录界面按要求输入登录名和密码,选择登录 3.登录界面审核登录信息确定登录成功,并跳转到管理主界面 |
分支流程: | 可能分支在正常流程的2处: 3.管理员不想继续完成功能,选择返回 4.系统返回到原界面 |
异常流程: | 无 |
相关用例: | DC9、DC10、DC11、DC12、DC13、DC14、DC15 |
业务规则: | 无 |
特殊需求: | 系统切换显示界面的响应时间小于0.5秒 |
假设: | 无 |
待确定问题: | 无 |
用例DC9:
对用例DC9的详细描述,描述的方式如下表所述。
ID: | DC9 |
名称: | 管理员修改密码 |
用例属性 | 创建者:;创建日期:2021-12-18 |
参与者: | 主要参与者:管理员 目标:对密码的修改。 |
描述: | 管理员想修改密码,提高账户的安全性,可以登录后台选择修改密码,修改后提示密码修改成功。 |
优先级: | 普通 |
触发条件: | 考研网上辅导系统服务器已经打开。 |
前置条件: | 管理员登录系统。 |
后置条件: | 密码修改成功 |
正常流程: | 1.管理员登录系统成功后,进入管理主界面 2. 在主界面上选择修改密码 3. 在修改密码界面进行密码修改 4.修改完成后选择确定 5.提示密码修改成功,并返回管理主界面 |
分支流程: | 可能分支在正常流程的2处: 3.管理员不想继续完成功能,选择返回 4.系统返回到原界面 |
异常流程: | 无 |
相关用例: | DC8 |
业务规则: | 无 |
特殊需求: | 系统切换显示界面的响应时间小于0.5秒 |
假设: | 无 |
待确定问题: | 无 |
用例DC10:
对用例DC10的详细描述,描述的方式如下表所述。
ID: | DC10.1 |
名称: | 查看文章信息 |
用例属性 | 创建者:;创建日期:2021-12-18 |
参与者: | 主要参与者:管理员 目标:查看文章信息。 |
描述: | 管理员需要及时查看文章信息,对用户发表的文章进行修改删除等操作 |
优先级: | 重要 |
触发条件: | 考研网上辅导系统服务器已经打开,用户已经打开网站。 |
前置条件: | 管理员登录系统界面 |
后置条件: | 登录成功,显示系统管理界面 |
正常流程: | 1.管理员登录系统成功后,进入管理主界面 2. 在主界面选择文章管理功能,进入文章管理主界面 3.登录界面审核登录信息确定登录成功 4、在文章管理主界面查看用户的所有文章信息 |
分支流程: | 可能分支在正常流程的2处: 3.用户不想继续完成功能,选择返回 4.系统返回到原界面 |
异常流程: | 无 |
相关用例: | DC8、DC11、DC15 |
业务规则: | 无 |
特殊需求: | 系统切换显示界面的响应时间小于0.5秒 |
假设: | 无 |
待确定问题: | 无 |
用例DC11:
对用例DC10的详细描述,描述的方式如下表所述。
ID: | DC10.2 |
名称: | 修改视频及资料 |
用例属性 | 创建者:;创建日期:2021-12-18 |
参与者: | 主要参与者:管理员 目标:修改视频及资料。 |
描述: | 管理员对学习视频及学习资料进行添加、修改和删除等操作。 |
优先级: | 重要 |
触发条件: | 考研网上辅导系统服务器已经打开,用户已经打开网站。 |
前置条件: | 管理员登录系统界面 |
后置条件: | 登录成功,显示系统管理界面 |
正常流程: | 1.管理员成功登录系统后,进入管理主界面 2. 在管理主界面选择视频资料功能,进入视频资料管理主界面 3. 在视频资料管理主界面对视频资料进行删除添加等操作 4、上传删除完成后选择确定,视频资料修改成功 |
分支流程: | 可能分支在正常流程的2处: 3.用户不想继续完成功能,选择返回 4.系统返回到原界面 |
异常流程: | 无 |
相关用例: | DC8、DC11、DC15 |
业务规则: | 无 |
特殊需求: | 系统切换显示界面的响应时间小于0.5秒 |
假设: | 无 |
待确定问题: | 无 |
用例DC21:
对用例DC10的详细描述,描述的方式如下表所述。
ID: | DC10 |
名称: | 查看用户信息 |
用例属性 | 创建者:;创建日期:2021-12-18 |
参与者: | 主要参与者:管理员 目标:查看用户信息。 |
描述: | 管理员可以查看所有用户的信息。管理员登录系统后进入用户管理界面,可以查看所有用户信息 |
优先级: | 重要 |
触发条件: | 用户信息管理功能之一 |
前置条件: | 管理员登录系统界面 |
后置条件: | 登录成功,显示系统管理界面 |
正常流程: | 1. 管理员成功登录系统后,进入管理主界面 2. 管理员在管理主界面选择用户管理功能,进入用户管理界面 3. 在用户管理界面,可以查看所有用户的信息 |
分支流程: | 可能分支在正常流程的2处: 3.管理员不想继续完成功能,选择返回 4.系统返回到原界面 |
异常流程: | 无 |
相关用例: | DC8、DC11、DC15 |
业务规则: | 无 |
特殊需求: | 系统切换显示界面的响应时间小于0.5秒 |
假设: | 无 |
待确定问题: | 无 |
用例DC22:
对用例DC10的详细描述,描述的方式如下表所述。
ID: | DC10 |
名称: | 修改用户密码 |
用例属性 | 创建者:;创建日期:2021-12-18 |
参与者: | 主要参与者:管理员 目标:修改用户密码。 |
描述: | 当用户忘记登录密码时,管理员可以登录系统帮助用户修改密码 管理员登录系统后进入用户管理界面,选择修改,在修改用户信息界面,修改用户密码,修改好后选择保存,密码修改成功 |
优先级: | 重要 |
触发条件: | 用户信息管理功能之一 |
前置条件: | 管理员登录系统界面 |
后置条件: | 登录成功,显示系统管理界面 |
正常流程: | 1. 管理员成功登录系统后,进入管理主界面 2. 管理员在管理主界面选择用户管理功能,进入用户管理界面 3.选择修改,进入用户信息修改界面 4、修改用户密码,选择保存 5、密码修改成功。 |
分支流程: | 可能分支在正常流程的2处: 3.管理员不想继续完成功能,选择返回 4.系统返回到原界面 |
异常流程: | 无 |
相关用例: | DC8、DC11、DC15 |
业务规则: | 无 |
特殊需求: | 系统切换显示界面的响应时间小于0.5秒 |
假设: | 无 |
待确定问题: | 无 |
用例DC23:
对用例DC10的详细描述,描述的方式如下表所述。
ID: | DC10 |
名称: | 删除用户 |
用例属性 | 创建者:;创建日期:2021-12-18 |
参与者: | 主要参与者:管理员 目标:删除用户。 |
描述: | 当用户常时间不登录系统视为无效用户,管理员可以对这些用户信息进行删除。管理员登录后对用户订单进行状态修改等管理 输出结果:系统显示管理员可以处理的所有用户订单。 |
优先级: | 重要 |
触发条件: | 用户信息管理功能之一 |
前置条件: | 管理员登录系统界面 |
后置条件: | 登录成功,显示系统管理界面 |
正常流程: | 1. 管理员成功登录系统后,进入管理主界面 2. 管理员在管理主界面选择用户管理功能,进入用户管理界面 3. 选择删除 4、并选择确定,用户删除成功 |
分支流程: | 可能分支在正常流程的2处: 3.管理员不想继续完成功能,选择返回 4.系统返回到原界面 |
异常流程: | 无 |
相关用例: | DC8、DC11、DC15 |
业务规则: | 无 |
特殊需求: | 系统切换显示界面的响应时间小于0.5秒 |
假设: | 无 |
待确定问题: | 无 |
用例DC24:
对用例DC15的详细描述,描述的方式如下表所述。
ID: | DC15 |
名称: | 数据库维护 |
用例属性 | 创建者:;创建日期:2021-12-18 |
参与者: | 主要参与者:管理员 目标:对数据的维护。 |
描述: | 管理员在进行日常管理时需要对数据进行定期备份或打印输出。管理员先登录系统,然后选择数据库维护,然后对数据进行相关的处理。 |
优先级: | 普通 |
触发条件: | 选择数据库维护 |
前置条件: | 管理员登录系统 |
后置条件: | 出现数据库维护界面 |
正常流程: | 1. 管理员成功登录系统后,进入管理主界面 2. 管理员在管理主界面选择数据库维护 3.根据需要打印数据或备份数据库 |
分支流程: | 可能分支在正常流程的2处: 3.管理员不想继续完成功能,选择返回 4.系统返回到原界面 |
异常流程: | 无 |
相关用例: | DC8 |
业务规则: | 无 |
特殊需求: | 系统切换显示界面的响应时间小于0.5秒 |
假设: | 无 |
待确定问题: | 无 |