本页面包含“Google 文档季”接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Oppia
- 技术文档工程师：
- atavar02
- 项目名称：
- 关于在 Oppia 上创建课程和相关资料的新手指南
- 项目时长：
- 标准时长（3 个月）
Project description
为什么选择 Oppia？
我过去曾担任教师，对教育和学习有着浓厚的兴趣。Oppia 的在线互动学习计划是辅导老师们发挥创意、在引人入胜的学习环境中接触学生的绝佳方式，让来自世界各地的学习者都能接触到这些资源。我很想成为这个全球社区的一员，为此网站的文档做贡献。
为什么要开展此项目？
随着在线学习在全球越来越普及，人们对平台的需求变得简单易用和管理，不仅对学生而言，对教师而言也是如此。Oppia 就是此类互动式学习平台之一，其目标是以一种引人入胜的线上方式重现一对一的学习场景。在 Oppia 这样的平台上取得成功的关键在于，教育服务提供商要能够创建有效的学习单元或“探索”，从而实现互动、对话和反馈。教育工作者的职责并没有到此结束 - 课程发布后，还可以根据学习者的互动和反馈来增强探索能力。
为 Oppia 制作新手指南并满足这些需求，是将我的技术写作技能与我热衷的主题（教育）结合起来的好方法。我刚刚获得了技术沟通证书，参与了多个项目，尤其关注用户体验、数字媒体和信息架构。通过这个项目，我将能够运用在计划中学到的技能。
项目计划和实施
理由
Oppia 上的教育服务提供商需要清晰且易于访问的工具和信息来创建探索，这时就要用到全面的文档。他们还需要了解改进探索的更复杂的任务。清晰明了的文档将带来令人满意的用户体验。
由于用户的学习风格不同，我们建议结合书面指南和视频教程。视频教程对视觉学习者很有吸引力，而且由于视频是专门针对特定任务的，因此用户可以快速获取所需信息。
受众群体分析
此项目的受众群体是想要创建探索或学习单元的用户。用户是对教学感兴趣的任何人，包括课堂教师、导师、希望分享经验和知识的退休人员、希望教授他人的学生自己、志愿者、教授等。这些不同用户在 Oppia 上执行的任务取决于他们的角色以及他们希望在 Oppia 中实现的任务。与希望向同学解释某个难懂概念的学生相比，符合条件的教师可能希望创建更全面的探索。
用户将拥有各种技能 - 从新手到其所在领域的专家。由于这个特定的项目关注的是那些超越基础知识（即更复杂任务）的指南，因此最常使用这些指南的群体是中级和专家。因此，这些指南应迎合这一范围，并为专家提供快速路径信息。
专业知识水平：中级
概念：需要理解更复杂的概念，例如规则、性质等。
Tasks：对更复杂的任务（例如添加旁白、图片、在探索中添加分支）更感兴趣。之前曾创建过课程计划，但不一定在 Oppia 上创建交互式计划。
参考资料： 该小组需要适量的文件。
专业水平：专家
概念：需要了解参数、嵌入等更高级的概念。
Tasks：需要学习如何将他们的教学专业知识与 Oppia 联系起来，或者如果他们已经了解 Oppia，请找出新更新中可能会涉及的任何新任务。这个群体也对复杂任务（如有效利用“历史记录”或“统计信息”标签）更感兴趣。
参考资料：之前与 Oppia 合作过，或者非常熟悉类似的学习平台。具备讲授和制定有效课程计划方面的专业知识。该小组需要的文件最少。
用户任务分析
规划探索：
- 创建故事大纲
- 围绕大纲规划探索
- 规划评估方法
示例：Neil 是一位首次使用 Oppia 的教师。在 Oppia 开始工作之前，Neil 需要规划要完成这项特定探索的学习成果或目标。然后，他需要构思一个引人入胜的场景，围绕此课程进行讲解。这有助于激发学习者的兴趣。
在规划探索时，Neil 会记得从简单的线性探索开始，因为他知道自己日后可以增加复杂性。他会思考如何给出解释，并测试学生的理解程度。根据学习者的回答，尼尔需要思考如何提供反馈并推动探索。
一旦对他的探索任务有了基本的概述，Neil 就可以开始在 Oppia 上工作了。
在课程中添加旁白（使用“翻译”标签页）：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/
平台
我建议继续使用 Oppia 目前托管其文档的 GitHub 页面。由于 GitHub 不允许嵌入视频，因此唯一的解决方法是插入链接到视频的图片，如上面的示例指南所示。
其他承诺
在该项目的实施阶段，我将处于美国东部夏令时间 (EDT) 时区。我可以承诺在整个项目期间内（即从 11 月结束到 11 月末）。
通信
联系频率取决于与导师的讨论情况。我更喜欢定期沟通，我建议每两周更新一次，并就目前为止所做的工作收到反馈。不过，这种方法也很灵活，具体取决于导师的偏好。