互动课堂 系统
需求说明书
修 改 记 录
*A – 新增 M – 修改 D – 删除
修改号 | 日期 | 影响的范围 | A* M D | 概 要 描 述 | 修改的需求号 |
1 | 2020-01-28 | A | 新增文档内容 | ||
raft-node="block" data-draft-type="table" data-size="normal" data-row-style="normal">
修改号 | 日期 | 影响的范围 | A* M D | 概 要 描 述 | 修改的需求号 |
1 | 2020-01-28 | A | 新增文档内容 | ||
目 录
1 引言 4
href="https://zhuanlan.zhihu.com/write#_Toc40040552">1.1 目的 4
href="https://zhuanlan.zhihu.com/write#_Toc40040553">1.2 预期的读者和阅读建议 4
href="https://zhuanlan.zhihu.com/write#_Toc40040554">1.3 产品的范围 4
href="https://zhuanlan.zhihu.com/write#_Toc40040555">1.4 参考文献 4
2 综合描述 5
href="https://zhuanlan.zhihu.com/write#_Toc40040557">2.1 用户类和特征 5
ef="https://zhuanlan.zhihu.com/write#_Toc40040558">2.1.1 系统使用人员 5
href="https://zhuanlan.zhihu.com/write#_Toc40040559">2.2 运行环境 5
href="https://zhuanlan.zhihu.com/write#_Toc40040560">2.3 设计和实现上的限制 6
3 系统功能需求 7
href="https://zhuanlan.zhihu.com/write#_Toc40040562">3.1 产品用例图 8
4 模块详细需求 8
href="https://zhuanlan.zhihu.com/write#_Toc40040564">4.1 细颗粒化的用例图 8
href="https://zhuanlan.zhihu.com/write#_Toc40040565">4.2 用例规约: 9
href="https://zhuanlan.zhihu.com/write#_Toc40040566">4.3 系统类图 19
5 附录 21
href="https://zhuanlan.zhihu.com/write#_Toc40040568">5.1 词汇表 21
href="https://zhuanlan.zhihu.com/write#_Toc40040569">5.2 数据字典 21
href="https://zhuanlan.zhihu.com/write#_Toc40040570">5.3 遗留问题 21
引言
目的
本文档详细的本文档详细描述“互动课堂”必须满足的功能需求、 非功能需求(质量属性和外部接口)与限制条件,作为本项目的项目管理人员、 系统设计人员、编码和测试人员以及与本项目相关的其他人员开展工作的基础和 依据,同时也界定了本项目的工作内容。
“互动课堂”系统主要目的:
- 解决用“慕课堂+腾讯会议”的传统线上教学模式中多种电子设备(电脑和手机,平板电脑)之间、不同APP之间频繁切换带来的不便。
- 解决“慕课堂”和“腾讯会议”两个相互独立的平台之间数据和教学内容不贯通的问题。
- 能够更加完整的记录、融合、统计学生在同一平台“互动课堂”的用户行为信息,便于教师在结课时,生成学生平时成绩更加便捷、科学、合理。
预期的读者和阅读建议
预期的读者是本公司的各部门负责人,系统分析师、系统设计人员、测试人员等。
产品的范围
适用于进行远程教学,师生互动,学生可在线签到打卡,学习,完成作业,参与测试,教师可以直播上课,上传资料,发布试题,管理学生成绩等
参考文献
- 《UML结构视图-类图》
- 《用例建模》
- 《UML行为视图-用例图》
综合描述
用户类和特征
本系统根据用户的使用特征分成 学生,老师,管理员。
系统使用人员
学生和老师允许登录并且在系统中进行相关权限分配后,分别在相应的学生端和教师端根据权限操作和使用系统,管理员可依据相应权限维护系统。
系统操作员 (老师,学生)
学生和老师根据角色权限表进行操作。
系统管理员
系统管理员可对系统进行维护和部分功能升级。
运行环境
使用腾讯公司开放的腾讯会议的API接口。
硬件环境
- 服务器:
华为云服务器
二、 Client 端包括 Windows、Mac OS、Android、IOS 设备.
软件环境
- 服务器操作系统为 Linux
- Java JDK 1.6+
- 数据库 Oracle
- 应用服务器采用 Apache Tomcat 5
- 客户端操作系统为 Windows、Mac OS、Android、IOS
设计和实现上的限制
- 本系统采用 Eclipse 开发。
- 版本管理使用 SVN Server 1.8+,客户端使用 TortoiseSVN 1.6.15, Build 21041 - 32 Bit
三. 建模设计工具为 PowerDesigner12 和 RationalRose2003
四. 原型工具使用 MockupsForDesktop。
五. 编程语言有 HTML、Java Script、Java、XML 等。
系统功能需求
本系统的目标:解决“慕课堂+腾讯会议”的传统模式下的需要多种电子设备同时参与、操作繁琐不方便的问题,使用腾讯开放的API接口,进行二次开发,研发一款融合“慕课 堂+腾讯会议”的新在线网络教学平台——互动课堂,实现多平台不同功能的融合,打造“一条龙”服务。
系统的核心功能:实现学生在线完成作业、参与考试、签到、讨论、观看直播课程、在线学习课程资源,以及教师直播授课、共享屏幕、发布作业、测试、上传资料、发布问卷、讨论互动、成绩管理的一体化服务。
第一阶段:
熟悉传统模式下的老师授课和学生学习的需求和相关流程
第二阶段:
实践调研并跟进“慕课堂+腾讯会议”模式,完善对需求的理解,并从中找到“互动课堂”新系统的功能研发和改进的出发点。
第三阶段:
熟悉腾讯会议的API接口,并将其很好的融合入“互动课堂”
进行相关的测试
第四阶段:
正式全面启用
产品用例图
模块详细需求
细颗粒化的用例图
用例规约:
(一)
用例:签到
相关需求:满足学生上课前进行签到
发起参与者:学生
参与者目标:学生课前签到,留下学习记录
参加参与者:老师
前置条件:学生已经登录成功
后置条件:系统将学生签到记录详情发送给老师
主成功场景事件流:
1.发起参与者(学生或老师)点击“签到”按钮进行签到。
2.系统提示签到成功,并把签到记录保存到数据库内
扩展事件流:
1a.未在上课期间按规定时间签到
1a.1系统提示学生“迟到”
1a.2系统把记录保存到数据库内
1b.未在本次上课期间进行签到
1b.1.系统提示学生“缺勤”
1b.2系统把记录保存到数据库内
1c.重复签到
1c.1.系统提示“已签到”,并跳转到直播上课的页面
(二)
用例:线上学习
相关需求:学生在线学习课程资源
发起参与者:学生
参与者目标:学生在线学习资源,并记录学生的学习相关的用户行为(学习时长,阅读次数)
参加参与者: 老师
前置条件:老师已经在课程内发布了课程学习相关资源
后置条件:系统将学生的学习记录归档后发送给老师
主成功场景事件流:
1.发起参与者(学生)进入并学习课程相关资源
2.学生退出系统,系统提示学习记录已保存,数据上传到数据库中
扩展事件流:
1a.课程资源不存在
1a.1系统提示学生“暂没有可用的资源”,并且跳转返回到主菜单
(三)
用例:完成线上任务——作业
相关需求:满足学生在线完成作业并通过系统平台提交给教师
发起参与者:学生
参与者目标:在线编辑作业,并远程提交于老师
参加参与者:老师
前置条件:老师已经将作业发布到系统
后置条件:系统将学生的作业统一的汇总提交到老师
主成功场景事件流:
1.发起参与者(学生)点击“作业”按钮进入作业模块
2.学生在线编辑完成作业
3.学生提交作业
扩展事件流:
1a.学生未在规定的时间内完成作业
1a.1系统提示学生“未在规定的时间内完成作业,无法提交”,并跳转到主菜单页面
2a.学生作业文件过大
2a.1.系统提示学生“作业文件过大,请以附件形式上传”,重新返回到作业编辑的富文本框
(四)
用例:完成线上任务——测试
相关需求:满足学生在线完成测试并通过系统平台提交给教师
发起参与者:学生
参与者目标:在线编辑试题答案,并远程提交于老师
参加参与者:老师
前置条件:老师已经将测试发布到系统
后置条件:系统将学生的试卷统一的汇总提交到老师
主成功场景事件流:
1.发起参与者(学生)点击“测试”按钮进入在线测试模块
2.学生在线编辑完成测试
3.学生提交试卷
扩展事件流:
1a.学生未在规定的时间内完成测试
1a.1系统提示学生“未在规定的时间内完成测试,无法提交”,并跳转到主菜单页面
2a.学生答案文件过大
2a.1.系统提示学生“答案文件过大,请以附件形式上传”,重新返回到富文本框
(五)
用例:登录注册
相关需求:满足用户(学生、老师)的登录注册
发起参与者:用户(老师,学生)
参与者目标:登录进入网站或注册个人账号
参加参与者:管理员
前置条件:用户点击主页“登录/注册”按钮进入”登录/注册”页面
后置条件: 登录/注册成功则提示登录/注册成功并进入网站主页;
登录/注册失败则提示登录/注册失败,并且返回”登录/注册”的页面
主成功场景事件流:
1.发起参与者填写用户名、密码、验证码,提交表单
2.系统判断用户名是否存在,密码、验证码是否正确,提示“登录成功”,学生进入学生端页面,老师进入教师端页面
扩展事件流:
1a.发起参与者输入的用户名、密码格式有误或者验证码有误
1a.1系统提示用户重新输入
1a.2用户根据提示重新输入
2a. 发起参与者输入的用户名不存在
2a.1系统提示用户注册,跳转到注册页面
2a.2用户输入注册信息进行注册,并进行教师/学生身份认证
2a.3系统提示“注册成功”,跳转到登录界面
(六)
用例:讨论互动
相关需求:满足学生和老师在线实时通讯或留言
发起参与者:学生,老师
参与者目标:学生和老师在上课的时候可以在聊天室进行实时交流,在课下学生如果有问题可以在讨论区给老师留言,教师可对留言作出回复
参加参与者:老师,学生
前置条件:学生和老师已经登录成功
后置条件:如果一个问题有过多的回复,系统对问题会进行折叠到“查看更多回复”
主成功场景事件流:
1.发起参与者(学生或老师)点击“互动交流”按钮进入相应功能。
2.系统从数据库加载历史留言信息并显示。
3.老师或学生在富文本框中编辑内容
4.老师或学生发送消息或发表内容
5.系统提示发送或发表成功,并把所有的消息缓存到本地、留言内容保存到数据库内
扩展事件流:
1a.老师或学生在非上课期间选择聊天室功能
1a.1系统提示老师或学生“非上课期间,无法进入聊天室,请在课程讨论区下留言”,并跳转到讨论区。
2a.加载失败
2a.1系统提示用户检查网络,刷新重试
(七)
用例:直播授课
相关需求:满足老师在线以直播的方式给学生上课
发起参与者:老师
参与者目标:以直播视频代替线下教室上课
参加参与者:学生
前置条件:老师点击“直播授课”按钮
后置条件:系统提示学生已经下课,提示老师直播结束,返回到主菜单界面
主成功场景事件流:
1.发起参与者(老师)开启直播间,设置直播间的“会议号”以及“入会密码”
2.系统提示老师创建成功,跳转到直播控制页面
3.参加参与者(学生) 输入会议号和入会密码进入直播间
扩展事件流:
1a.发起参与者(老师)输入的会议号、密码格式有误
1a.1系统提示用户重新输入
1a.2用户根据提示重新输入
2a.直播过程中出现信号不良的状况
2a.1系统提示教师“信号不良”,重新检查网络
3a. 参加参与者(学生) 输入会议号和入会密码有误
3a.1系统提示用户重新输入
3a.2用户根据提示重新输入
(八)
用例:管理成绩数据
相关需求:综合管理学生各项用户行为产生的数据。
发起参与者:老师
参与者目标:依据数据加权之后可以生成最后成绩
参加参与者: 无
前置条件:老师已经在课程内发布了课程学习相关资源
后置条件:系统将学生的学习记录归档后发送给老师
主成功场景事件流:
1.发起参与者(老师)点击“管理成绩”,设置各项成绩权重
2.系统根据教师的设置自动生成综合成绩
扩展事件流:
1a.各权重之和大于100%
1a.1系统提示教师“权重设置有误,请重新设置”
(九)
用例:课程建设——题库管理
相关需求:满足老师上传和发布作业习题或测试
发起参与者:老师
参与者目标:老师可以建设和管理题库
参加参与者: 学生
前置条件:老师已经登录成功
后置条件:向学生发出新作业、新测试通知
主成功场景事件流:
1.发起参与者(老师)将习题上传并保存在系统的题库
2.老师设置评分规则和时间并发布
3.系统提示发布成功
扩展事件流:
1a.重复添加相同的题目
1a.1系统提示老师“此题目已经存在,不能重复添加”,并将新添加的重复题目删除
(十)
用例:课程建设——学习资料上传
相关需求:满足老师上传学习资料和相关资源
发起参与者:老师
参与者目标:老师可以建设和上传有关资料
参加参与者: 学生
前置条件:老师已经登录成功
后置条件:向学生发出新学习资料以及相关资源更新的通知
主成功场景事件流:
1.发起参与者(老师)将学习资源上传并保存在系统
2.系统提示发布成功
扩展事件流:
1a.重复添加相同的学习资源
1a.1系统提示老师“此资源已经存在,不能重复添加”,并将新添加的重复资源删除
(十一)
用例:课程建设——建立课程并发布邀请码
相关需求:使相同班级的学生可以聚合在一起
发起参与者:老师
参与者目标:老师可以建设新课堂并生成相应课堂邀请码
参加参与者: 学生
前置条件:老师已经登录成功
后置条件:向学生发出新生成的课程邀请码
主成功场景事件流:
1.发起参与者(老师)新建课程
2.系统提示新建成功
3.老师在此课程内点击“生成课程邀请码”按钮,设置将要生成的邀请码
4.系统提示课程邀请码生成成功,并将邀请码保存到数据库中
扩展事件流:
3a.重复点击“生成课程邀请码”按钮
3a.1系统提示新生成的邀请码将覆盖之前的邀请码
3a.2老师编辑新的邀请码,输入系统
3a.3系统在数据库中更新信息
系统类图
系统的类图
任务描述列表(任务要细粒度)
条目 | 内容描述 | 示例 | |
1. | 任务名称 | 简单,明确描述任务内容 | 构建组装,HiC 实验 |
2. | 负责部门 | 任务负责部门 | 根据公司组织架构 |
3. | 参与部门 | 任务参与部门 | |
4. | 版本号 | 版本号,加上最后修改日期 | V1.0-2020-01-28 |
5. | 修改记录 | 姓名+修改日期 | 张三+2020-01-28 |
6. | 任务描述 | 详细描述任务 | |
7. | 所需要的资源 | 计算资源,设备,资金等 | |
8. | 先决条件 | 完成任务所需数据,样本等 | 测试数据,语料注释文件, |
9. | 任务规范 | 任务完成指南,步骤 | |
10. | 完成结果 | 任务完成的标准,指标,输出结果 | XX 文件,N50>1M |
11. | 平均成本 | 作为报价参考 |
附录
词汇表
编号 | 词汇名称 | 说明 |
1. | ||
2. |