本页详细介绍了 Google 文档季收录的技术文案项目。
项目摘要
- 开源组织：
- Oppia
- 技术文档工程师：
- atavar02
- 项目名称：
- 关于在 Oppia 上创建课程和相关资料的初学者指南
- 项目时长：
- 标准时长（3 个月）
Project description
为什么选择 Oppia？
我曾担任过教师，对教育和学习非常感兴趣。Oppia 的在线互动学习平台是一种绝佳的方式，可以让教师发挥创造力，在充满吸引力的学习环境中与学生交流互动，让世界各地的学习者都能获取这项资源。我非常乐意成为这个全球社区的一员，为此网站的文档贡献力量。
为什么要启动此项目？
随着在线学习在全球范围内日益普及，人们需要简单易用且易于管理的平台，这不仅适用于学生，也适用于教师。Oppia 就是这样一个互动式学习平台，旨在以富有吸引力的方式在线重现一对一学习场景。在 Oppia 等平台上取得成功的关键在于，教育机构能够创建能够实现互动、对话和反馈的有效学习单元或“探索”。教育工作者的作用并不是就此结束 - 课程发布后，根据学员的互动和反馈，课程内容还有改进空间的余地。
在满足这些需求的同时，为 Oppia 创建一本初学者指南，将是我将技术写作技能与我热爱的教育主题相结合的绝佳方式。我刚刚获得了技术沟通证书，在完成项目的过程中，我重点关注了用户体验、数字媒体和信息架构，而这个项目将让我能够运用我在该课程中学到的技能。
项目计划和实施
理由
Oppia 上的教育机构需要使用简单易用的工具和信息来创建探索，而全面的文档正是为此而生。他们还需要了解改进探索的更复杂任务。简明易懂的文档会带来令人满意的用户体验。
由于用户的学习风格不同，我们建议将书面指南和视频教程相结合。视频教程对视觉学习者很有吸引力，由于视频专门针对特定任务，因此用户可以快速获得所需信息。
受众群体分析
此项目的受众群体是希望创建探索或学习单元的用户。用户是指对教学感兴趣的任何人，包括课堂教师、辅导教师、希望分享其经验和知识的退休人员、希望教导他人的学生、志愿者、教授等。这些不同用户在 Oppia 上执行的任务将取决于他们的角色以及他们希望通过 Oppia 实现的目标。与想要向同学解释某个难题的学生相比，合格的教师可能希望创建更全面的探索。
用户的技术水平各不相同，从新手到各领域的专家都有。由于此特定项目侧重于介绍超越基础知识的指南（即更复杂的任务），因此最常使用这些指南的群体是中级用户和专家。因此，指南应适应这一范围，并为专家提供快捷方式信息。
专业水平：中级
概念：需要了解更复杂的概念，例如规则、特征等。
任务：更感兴趣于更复杂的任务，例如添加旁白、图片、向探索添加分支等。之前曾创建过课程大纲，但不一定是在 Oppia 上创建的互动式大纲。
参考文献：此类别需要中等数量的文档。
专业水平：专家
概念：需要了解参数、嵌入等更高级的概念。
任务：需要了解如何将自己的教学专业知识与 Oppia 进行匹配；如果他们已经了解 Oppia，则需要找出更新版本带来的新任务。这类用户还对复杂任务更感兴趣，例如有效使用“历史记录”或“统计信息”标签页。
参考：曾与 Oppia 合作过，或非常熟悉类似的学习平台。具备教学和制定有效课程的专业知识。此类教师需要的文档最少。
用户任务分析
规划探索：
- 创建故事大纲
- 围绕大纲规划探索
- “规划”评估方法
示例：Neil 是一位首次使用 Oppia 的教师。在开始在 Oppia 中工作之前，Neil 必须先规划此特定探索的学习成果或目标。然后，他必须构思一个有吸引力的场景来构建课程。这将激发学习者的兴趣。
在规划探索时，Neil 记得先从简单的线性探索开始，因为他知道之后可以增加复杂性。他将思考如何给出解释，并检验学员的理解情况。Neil 必须根据学员的回答，考虑如何提供反馈并推进探索。
在对自己的探索内容有了基本概述后，Neil 就可以开始在 Oppia 中工作了。
为课程添加旁白（使用“翻译”标签页）：Neil 还可以为卡片添加旁白或将其翻译成其他语言。如果 Neil 想添加其他语言的旁白，则必须先将卡片翻译成该语言，然后才能添加旁白。
使用“历史记录”标签页：Neil 可以通过“历史记录”标签页选择还原较早保存的探索版本，还可以通过此标签页下载和保存较早的版本。
使用“反馈”标签页：学习者可以在探索过程中随时选择留下反馈。Neil 可以查看此反馈，并据此改进他的课程。他可以回复消息，并可以通过多种方式更改消息的状态（已解决、无法处理等）
通过统计信息和游戏过程（使用“统计信息”标签页）改进课程：Neil 发布了探索，并让不同的学习者进行探索，他希望根据学习者的互动情况改进探索。他可以通过以下几种方式改进课程。
他可以开始在探索中构建更复杂的结构，方法是创建最终会返回到他之前创建的主分支的分支。他可能会为更高级的学习者提供捷径，这样可以防止他们感到无聊，并提高他们的互动度。他可能会考虑使用参数，以便针对特定学员自定义相应游戏体验。
添加图片和视频：Neil 还可以在创建特定卡片时添加图片、视频和链接。
邀请其他用户加入探索：Neil 可以邀请其他用户加入他的探索，并为他们分配以下不同角色：
- 管理员
- 协作者
- 译者
- Playtester
每个角色都可以控制其下级角色的功能，因此“经理”角色拥有最多的功能。由于 Neil 创建了这项探索，因此他获得了 Oppia 中的“经理”角色。
建议的指南（基于用户任务分析）
规划课程
- 创建故事大纲 / 场景
- 构建基于场景的课程
- 规划评估方法（包括如何编写练习题）
为课程添加旁白（使用“翻译”标签页）
- 为课程原文添加旁白
添加其他语言的旁白
- 翻译卡片中的文本 *录制第二种语言的旁白
有效使用“统计信息”“历史记录”和“反馈”标签页
使用图片、视频、链接等设置课程内容的格式
使用统计数据和演示提高课程效果
- 向现有课程添加分支
- 为更高级的学习者创建快捷方式
邀请其他用户加入课程（角色）
- 角色类型及其层次结构
实现
采用的方法：
Oppia 的文档包含书面指南和视频教程，非常易于使用（如需查看示例，请参阅下面的“示例指南”部分）。这有助于满足不同的学习风格，并为用户提供更多了解 Oppia 运作方式的选项。
方案：
该项目将包括用户指南和视频教程。该指南和视频将涵盖上文“建议的指南”部分中详述的内容，但有一个例外情况（第一个指南“规划课程”不需要视频）。视频将嵌入到介绍用户任务的页面中。
每周里程碑：
开发阶段为 2019 年 9 月 2 日至 11 月 22 日。
第 1、2 和 3 周（9 月 2 日至 20 日）：
规划课程（创建故事大纲 / 场景、设计基于场景的课程、规划评估方法（包括如何撰写练习题）
第 4 周（9 月 23 日至 27 日）：
为课程添加旁白
第 5、6 和 7 周（9 月 20 日至 10 月 18 日）：
有效使用“统计信息”“历史记录”和“反馈”标签页
第 8 周（10 月 21 日至 25 日）：
为课程内容设置格式，包括图片、视频、链接等。 邀请其他用户加入课程（角色）
第 9、10 和 11 周（10 月 28 日至 11 月 15 日）：
利用统计信息和试玩内容巩固课程
第 12 周（11 月 18 日至 22 日）：
查看和修改
示例指南和视频教程
https://audstav.github.io/oppiasampleguide/
平台
我提议继续使用 GitHub 页面，而 Oppia 目前托管了其文档。由于 GitHub 不允许嵌入视频，因此唯一的解决方法是插入链接到视频的图片，如上面的示例指南所示。
其他承诺
在该项目的实施阶段，我所在的时区为美国东部夏令时 (EDT)。我可以承诺在整个项目期间（即 11 月底之前）提供支持。
通信
联系频率取决于与导师的讨论结果。我更喜欢定期沟通，建议每两周一次，以便提供最新动态并就到目前为止完成的工作收到反馈。不过，这也取决于导师的偏好。