在线学习平台概要设计说明书文档格式.doc
《在线学习平台概要设计说明书文档格式.doc》由会员分享,可在线阅读,更多相关《在线学习平台概要设计说明书文档格式.doc(479页珍藏版)》请在冰豆网上搜索。
![在线学习平台概要设计说明书文档格式.doc](https://file1.bdocx.com/fileroot1/2022-11/2/8461ca4b-44bc-49ab-b8fc-c7a06ba5fc03/8461ca4b-44bc-49ab-b8fc-c7a06ba5fc031.gif)
修订时间:
创建或修订当前版本成果物的日期。
内容:
填写该版本成果物形成文件、修改内容等。
修订人:
参与此文档的编辑、修订的人员姓名
批准人:
批准此文档的项目技术负责人员。
正式发布的版本要求批准人必须是本项目的技术负责人。
IV
目录
1. 引言 1
1.1. 项目目标 1
1.2. 系统概述 2
1.3. 文档概述 3
1.4. 术语 4
1.5. 参考资料 5
2. 总体设计 6
2.1. 设计思想 6
1.1.1 需求概述 6
1.1.2 设计方法 9
2.2. 运行环境 10
2.2.1. 独立部署环境 12
2.2.2. 测试验证云环境(虚拟资源) 15
2.2.3. 公有云环境(虚拟资源) 18
2.2.4. 公有云环境多租户模式 18
2.3. 系统总体架构 18
2.3.1. 系统组成、功能结构 19
2.3.2. 系统层次划分 22
2.3.3. 系统工作流程 24
2.4. 总体界面设计 24
2.4.1. 设计原则 24
2.4.2. 设计思路 25
2.4.3. 设计风格 26
3. 系统设计 28
3.1. 总体情况 28
3.1.1. 子系统模块结构 33
3.1.2. 课程学习(DS-13-01-01) 33
3.1.3. 系列课程(DS-13-01-02) 35
3.1.4. 在线自测(DS-13-01-03) 37
3.1.5. 组卷自测(DS-13-01-04) 38
3.1.6. 提问答疑(DS-13-01-05) 40
3.1.7. 主题研讨(DS-13-01-06) 42
3.1.8. 学习笔记(DS-13-01-07) 43
3.1.9. 消息通讯(DS-13-01-08) 45
3.1.10. 我的课程(DS-13-01-09) 47
3.1.11. 我的社区(DS-13-01-10) 48
3.1.12. 我的题库(DS-13-01-11) 50
3.1.13. 我的订单(DS-13-01-12) 52
3.1.14. 我的档案(DS-13-01-13) 53
3.1.15. 好友空间(DS-13-01-14) 55
3.1.16. 个人设置(DS-13-01-15) 57
3.1.17. 登录/注册(DS-13-01-16) 58
3.2. 在线学习APP(DS-13-02) 60
3.2.1. 子系统模块结构 60
3.2.2. 课程学习(DS-13-02-01) 60
3.2.3. 精品套卷(DS-13-02-02) 62
3.2.4. 智能组卷(DS-13-02-03) 64
3.2.5. 我的课程(DS-13-02-04) 65
3.2.6. 我的题库(DS-13-02-05) 67
3.2.7. 我的关注(DS-13-02-06) 69
3.2.8. 消息通知(DS-13-02-07) 70
3.2.9. 我的订单(DS-13-02-08) 72
3.2.10. 个人设置(DS-13-02-09) 74
3.2.11. 离线缓存(DS-13-02-10) 75
3.2.12. 登录(DS-13-02-11) 77
3.3. 内容制作系统(DS-13-03) 79
3.3.1. 子系统模块结构 79
3.3.2. 我的课程(DS-13-03-01) 79
3.3.3. 课程制作(DS-13-03-02) 81
3.3.4. 课程导入(DS-13-03-03) 82
3.3.5. 我的试题(DS-13-03-04) 84
3.3.6. 试题制作(DS-13-03-05) 86
3.3.7. 试题导入(DS-13-03-06) 87
3.3.8. 我的试卷(DS-13-03-07) 89
3.3.9. 手工组卷(DS-13-03-08) 91
3.3.10. 智能组卷(DS-13-03-09) 92
3.3.11. 作业练习(DS-13-03-10) 94
3.3.12. 作业发布(DS-13-03-11) 96
3.4. 内容管理系统(DS-13-04) 97
3.4.1. 子系统模块结构 98
3.4.2. 课程管理(DS-13-04-01) 98
3.4.3. 试题管理(DS-13-04-02) 99
3.4.4. 试卷管理(DS-13-04-03) 101
3.4.5. 课程评论管理(DS-13-04-04) 103
3.4.6. 课程笔记管理(DS-13-04-05) 104
3.4.7. 研讨学习管理(DS-13-04-06) 106
3.4.8. 问答回复管理(DS-13-04-07) 108
3.5. 系统管理系统(DS-13-05) 110
3.5.1. 子系统模块结构 110
3.5.2. 账户管理(DS-13-05-01) 110
3.5.3. 角色管理(DS-13-05-02) 112
3.5.4. 菜单管理(DS-13-05-03) 113
3.5.5. 机构管理(DS-13-05-04) 115
3.5.6. 课程分类管理(DS-13-05-05) 117
3.5.7. 知识点管理(DS-13-05-06) 118
3.5.8. 敏感词管理(DS-13-05-07) 120
3.5.9. 数据字典配置(DS-13-05-08) 122
3.5.10. 通知管理(DS-13-05-09) 123
3.5.11. 日志管理(DS-13-05-10) 125
3.5.12. 升级管理(DS-13-05-11) 127
3.5.13. 问题反馈管理(DS-13-05-12) 128
3.5.14. 平台管理(DS-13-05-13) 130
3.5.15. 数据统计(DS-13-05-14) 132
3.6. 分析中心(DS-13-06) 133
3.6.1. 子系统模块结构 134
3.6.2. 概况统计(DS-13-06-01) 134
3.6.3. 课程统计(DS-13-06-02) 135
3.6.4. 题库统计(DS-13-06-03) 137
3.6.5. 问答统计(DS-13-06-04) 139
3.6.6. Top10排行榜(DS-13-06-05) 140
3.6.7. 课程排行明细(DS-13-06-06) 142
3.6.8. 试卷排行明细(DS-13-06-07) 144
3.6.9. 移动学习统计(DS-13-06-08) 146
3.6.10. 学习时段统计(DS-13-06-09) 147
3.6.11. 课程分类排行(DS-13-06-10) 149
3.6.12. 学员排行明细(DS-13-06-11) 151
4. 接口设计 152
5. 数据库设计 153
6. 软件部署设计 154
7. 非功能性设计 155
7.1. 性能设计 155
7.1.1. 应用性能设计 156
7.1.2. 中间件性能设计 159
7.1.3. 数据库性能设计 160
7.1.4. 尽量使用高效的存储 164
7.2. 安全设计 165
7.2.1. 审计信息 165
7.2.2. 代码安全 165
7.2.3. 输入处理 168
7.2.4. WEB应用 168
7.2.5. 会话 169
7.3. 系统出错处理设计 169
7.3.1. 异常处理原则 171
7.3.2. 异常分类 172
7.3.3. 异常记录 173
7.4. 系统维护设计 173
7.4.1. 主机类监控 173
7.4.2. 数据库监控 174
7.4.3. 中间件监控 174
7.4.4. 应用情况监控 175
7.4.5. 负载设备的监控 175
8. 尚待解决的问题 176
9. 附件 176
473
1.引言
1.1.项目目标
【编写要求:
简述本系统的项目背景和建设目标,并说明本项目/系统与工程中其他项目/系统之间的关系。
简要说明V1.0所达到的目标。
】
在线学习平台是数字时代XXXX为广大用户提供增值服务的平台,在充分吸取教育技术理论与方法最新研究成果的基础上,利用网络技术,根据不同教学模式、不同教育对象的特点,在不同的教学环节中为网络教学提供灵活的、可缩放的、适合于多种层面、多种对象及多种网络环境的交互式教与学支撑环境。
在线学习平台是一个基础的学习平台,目标定位为XXXX培训教育,设计理念以课程为中心,聚焦XXXX教育、XXXX继续教育。
系统支持独立部署,也支持多级XXXX下的公有云部署方式。
1.2.系统概述
【编写说明:
简述本文档适用的系统和软件的用途。
它应描述系统与软件的一般性质;
概述系统开发、运行和维护的历史;
标识项目的投资方、需方、用户、开发方和支持机构;
标识当前和计划的运行现场;
并列出其他有关文档。
本文档适用于在线学习平台,包括学习业务、业务管理两大系统。
学习平台可以为有需要的XXXX提供在线学习的平台基础,使之成为服务于教育、承载优质资源、联合教员学员的重要支撑平台。
1、学习业务:
主要包含了在线学习平台Web、在线学习APP两大模块,为学员提供课程学习、在线考试、自测、答疑、互动交流、移动学习服务;
2、业务管理:
主要是为了支撑学习业务而提供的服务,包括了内容的制作、内容的审核、系统管理、分析中心等多个模块。
主要使用对象为各级管理员、教员。
系统运行于linux平台下,运用了java,mysql,spring,ibatis,jquery,android,公共组件等软件进行开发和维护。
开发、运行、维护历史:
无。
1.3.文档概述
概述本文档的用途与内容,并描述与其使用有关的保密性或私密性要求,以及预期读者】
本文档主要说明对系统的设计考虑,包括系统的主要业务流程、模块划分、功能分配、接口设计、运行设计、数据结构设计和安全性设计等,为程序的设计研发奠定基础。
为开发人员提供开发实现的具体路线、依据和约束,也为测试人员的测试工作提供依据和指导。
1.4.术语
为提供正确理解本文档所需的术语、概念和缩略语的定义或解释。
表11术语列表
序号
术语、概念、略缩语
定义或解释
1.
公有云
第三方提供的能够部署平台服务的网络环境,用户可以通过internet访问系统
2.
多租户
在一台服务器上运行单个应用实例,它为多个租户提供服务
1.5.参考资料
提供撰写本文档的参考资料清单,列出这些资料的名称、发布日期、单位或资料来源。
表12参考资料表
资料名称
发布日期
资料来源
备注
5.
2.总体设计
2.1.设计思想
概述本项目/系统总体需求,阐述基于该需求的系统设计思想,说明系统设计中需遵循的一些约定和约束。