广州市司法局综合在线培训平台

1. 引言

1.1编写目的

根据广州市司法局综合在线培训平台的业务需求，并经与需求人员沟通，明确了在线培训平台在业务上能做什么，在做的时候有什么要求。具体每一步是怎么做的，要达到什么目地，产生什么结果。
本文档旨在描述对广州市司法局综合在线培训平台的详细设计，以便为后续各模块的设计、实现提供依据。本文的预期读者为项目管理人员、项目开发人员和用户。

1.2背景

广州市司法局综合在线培训平台是基于IP网络技术建立的一套远程教育培训系统。系统主要实现将培训会场内的音视频信息、PPT课件等，经采集和转换成为可基于IP实时在线观看的网络视频资源，可通过网络传输到学员的PC机，给学员提供丰富而便捷的学习途径。系统可实现培训过程的录制、点播与回放、音视频交互、word课件查看、留言等功能，大大提升远程培训的效率与质量。本系统旨在对司法局内部员工进行业务知识培训、实现内部交流和资源共享。
本文档适用于所有与广州市司法局综合在线培训平台有关的软件开发阶段的相关人员，其中甲方：客户代表。乙方：项目经理、技术开发人员（包括分析人员、设计人员、程序人员）。

1.3定义

定义表1-1 

缩略语	英文	中文解释

1.4参考资料

广州司法局综合信息指挥平台用户需求说明书_v1.0

2．程序系统的结构

程序结构表2-1

系统模块	业务功能
登陆页面	用户根据用户名和密码登陆该培训系统。
首页	首页主要给用户展示的是视频学习资料、视频一周播放排行榜和文档资料列表、文档一周排行榜。
视频模块	提供给用户可使用的视频学习资源。
文档模块	提供给用户可使用的文档类型学习资源，并且用户可以根据自己需求进行文档上传。

图2.1 程序结构图

3．登陆首页设计说明

3.1程序描述

在该模块中，用户需要提供唯一能够识别的用户名和密码才可以进入平台进行资源学习和资源共享。

图3.1  司法平台登陆页面

3.2功能

用户提供唯一的用户名和密码，直接进入培训平台进行资源学习和共享。

3.3性能

要求用户登陆跳转到培训平台首页的时间为3秒。

3.4输人项

用户信息表 3-1 
用户信息表(USER)

字段名	物理名	类型	备注
ID	USERTID	NUMBER	PK & not null
用户名	USERNAME	VARCHAR2(100)	not null
密码	PASSWORD	VARCHAR2(32)	not null

3.5输出项

当用户输入正确的用户名和密码时，直接跳转进入培训平台首页。当验证失败时，系统将跳出提示，要求用户重新输入用户名和密码。

3.6算法

当用户输入用户名和密码后，系统将去数据库中，在用户信息表（USER）中查找相关数据，判断输入的数据是否存在。若存在，直接跳转到首页，若不存在，则提示重新输入。

3.7流程逻辑

图3.2  登陆页面流程逻辑图

3.18注释设计

说明准备在本程序中安排的注释，如：

• 加在模块首部的注释；
• 加在各分枝点处的注释；
• 对各变量的功能、范围、缺省条件等所加的注释；
• 对使用的逻辑所加的注释等等。

3.9限制条件

用户登陆使用的用户名和密码必须是在用户信息表（USER）表中的数据。

3.10测试计划

该模块将用户信息表（USER）中的数据进行测试，测试用例如下：
登录首页测试用例表 3-2

用例名称： 培训平台登陆
用例描述	用于平台登陆，当用户名存在和密码正确的情况下则进入系统。
用例入口	在地址栏输入相应的地址，进入该系统的登陆页面。
测试用例ID	场景	测试步骤	预期结果	备注
TD1	用户名输入	输入已存在的用户名：gzsf0001	输入成功
TD2	用户名-容错性检验	输入：ggggggggggggg	输入到蓝色字符是，系统拒绝输入	输入数据超过规定长度范围
TD3	密码输入	输入用户gzsf0001的相关数据。	输入成功
TD4	登陆成功	T1、T2,单击登陆按钮。	登陆成功，进入平台首页
TD5	用户名和密码校验	没有输入用户名和密码，单击登录按钮。	系统登录失败，并提示：请检查用户名和密码的输入是否正确。
TD6	密码校验	输入用户名，未输入密码，单击登录按钮。	系统登录失败，并提示：需要输入密码。
TD7	密码有效性校验	输入用户名，输入的密码和用户名不一致，单击登录按钮。	系统登录失败，并提示：错误的密码。
TD8	输入有效性校验	输入不存在的用户名和密码，单击登录按钮。	系统登录失败，并提示：用户名不存在。

 

3.11尚未解决的问题

无。

4. 培训平台首页设计说明

4.1程序描述

用户进入培训平台后，可浏览到视频和文档的学习资源，并可以通过分类导航根据自己的需求进行资源查找。并且可以查看到近期一周的资源排行榜。

图4.1 首页分类导航

图4.2 培训平台首页

4.2功能

主要向用户展示了资源库中视频和文档资源，供用户使用。并提供分类导航给用户进行选择。

4.3性能

要求在一定的时间内能够从后台将数据取回到页面展示。并能够根据用户对分类导航的点击，查找到用户所需要的分类资源。

4.4注释设计

说明准备在本程序中安排的注释，如：

• 加在模块首部的注释；
• 加在各分枝点处的注释；
• 对各变量的功能、范围、缺省条件等所加的注释；
• 对使用的逻辑所加的注释等等。

4.5限制条件

说明本程序运行中所受到的限制条件。

4.6测试计划

4.7尚未解决的问题

说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。
 

5. 视频详情页面设计说明

5.1程序描述

在该模块中，用户可根据筛选条件进行视频学习资料浏览，并且用户可以根据关键字搜索来查找自己需要的视频资源。

图5.1 视频详情页面

5.2功能

用户可以进行视频资源的浏览，进行远程学习。还可以使用搜索引擎进行关键字搜索。

5.3性能

要求能够根据筛选条件和搜索引擎找到相应关键字的资源。

5.4输入项

5.4.1 视频列表信息表(Video_List)

表5-1 视频列表信息表

字段名	物理名	类型	备注
ID	VIDEOID	NUMBER	PK & not null
视频名称	VIDEONAME	VARCHAR2(100)
创建时间	CREATDATE	DATE	not null
浏览次数	VIEWTIMES	NUMBER
视频类型	V_TYPE_ID	NUMBER	FK

5.4.2 视频类型表(Document_Type)

表5-2 视频类型表

字段名	物理名	类型	备注
视频类型	V_TYPE_ID	NUMBER	PK &FK
类型名称	V_TYPE_NAME	VARCHAR2(100)

5.5输出项

用户点击相应的视频项目时应跳转到视频播放页面。并且可以根据筛选条件来获取到资源。

5.6算法

1、当用户使用搜索引擎时，在后台查找到含有该关键字的数据，并且将数据返回前台展示在页面上。
2、当用户需要浏览某个视频资源时，根据用户的请求需要后台响应，找到对应的数据返回到页面，供用户学习。

5.7流程逻辑

图5.2 视频详情页面流程逻辑图

5.8注释设计

说明准备在本程序中安排的注释，如：

• 加在模块首部的注释；
• 加在各分枝点处的注释；
• 对各变量的功能、范围、缺省条件等所加的注释；
• 对使用的逻辑所加的注释等等。

5.9限制条件

搜索框中输入的关键字需要在一定的约束条件下。

5.10测试计划

     请参考 综合培训平台系统功能测试计划.docx

5.11尚未解决的问题

无。
 

6．文档详情页面设计说明

6.1程序描述

在文档详情页面中，用户可根据筛选条件进行文档学习资料浏览，并可以根据个人需求进行文件上传。

图6.1 文档详情页面
 

图6.2 文档上传弹出框

6.2功能

用户可以进行文档资源的浏览，并可以进行文档资源上传。

6.3性能

要求在一定时间内能够展示出文档列表，并且能够将上传文档的记录在页面中展示出来。

6.4输入项

6.4.1 文档列表信息表(Document_List)

文档列表信息表 6-1

字段名	物理名	类型	备注
ID	DOCUMENTID	NUMBER	PK & not null
文档名称	DOCUMENTNAME	VARCHAR2(100)
创建时间	CREATDATE	DATE	not null
文档类型	D_TYPE_ID	NUMBER	FK
文档地址	LINKADDRESS	VARCHAR2(200)

6.4.2 文档类型表(Document_Type)

文档类型表 6-2

字段名	物理名	类型	备注
文档类型	D_TYPE_ID	NUMBER	PK &FK
类型名称	D_TYPE_NAME	VARCHAR2(100)

6.5输出项

页面返回出用户所需要的资源，并且对用户上传的文档保存，将记录添加到数据库中。

6.6算法

1、当用户需要浏览某个文档时，根据用户的请求需要后台响应，找到对应的数据返回到页面，供用户学习，并且该文档不能进行复制等操作。
2、用户上传文档时，上传成功后应将相应的记录添加到文档列表信息表(Document_List)。

6.7流程逻辑

图6.3 文档详情页面流程逻辑图

6.8注释设计

说明准备在本程序中安排的注释，如：

• 加在模块首部的注释；
• 加在各分枝点处的注释；
• 对各变量的功能、范围、缺省条件等所加的注释；
• 对使用的逻辑所加的注释等等。

6.9限制条件

文档浏览过程中，用户不能对文档进行复制等操作。并在文档上传时，文档格式和大小必须符合一定的相应的约束条件。

6.10测试计划

该模块将对用户上传的数据进行测试，测试用例如下：
文件上传测试用例表 6-3

用例名称： 文件上传
用例描述	用于文件上传，当文件大小和格式符合要求时则上传成功。
用例入口	在首页和文档详情页面点击上传文件按钮进行文件上传操作。
测试用例ID	场景	测试步骤	预期结果	备注
TS1	文件上传	上传符合文件格式的文件	上传成功。
TS2	文件大小	上传的文件大小大于或小于约束条件	上传失败，提示：文件大小不符合要求。	上传数据不在规定的范围内
TS3	文件格式	上传的文件格式不正确	上传失败，提示：文件格式错误。	上传文件格式不符合要求

 
 

• 学生WEB端操作手册 顶岗实习管理软件
• 教师WEB端操作手册 顶岗学习管理软件
• 顶岗实习学院用户客户端操作手册
• 职业技术学院顶岗实习管理软件
• 顶岗实习信息管理APP学生版操作手册（六
• 顶岗实习信息管理APP学生版操作手册（五
• 顶岗实习信息管理APP学生版操作手册（四
• 顶岗实习信息管理APP学生版操作手册（三
• 顶岗实习信息管理APP学生版操作手册（二
• 顶岗实习信息管理APP学生版操作手册（一
• 顶岗学生实习信息化管理平台（实习成绩
• 顶岗实习信息化管理平台学生版（管理制