本页面包含有关 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 需要思考如何给予反馈，从而继续进行探索。
一旦 Neil 对他的探索任务有了基本的概述，他就可以开始在 Oppia 中工作了。
在课程中添加旁白（使用“翻译”标签页）：Neil 还可以为卡片添加旁白或将其翻译成其他语言。如果他想添加其他语言的旁白，他必须先将卡片翻译成该语言，然后他才能添加旁白。
使用“历史记录”标签页：他可以选择通过“历史记录”标签页还原到之前保存过的探索版本。通过该标签页，Neil 还可以下载并保存旧版本。
使用“反馈”标签页：学习者可以在探索过程中随时提供反馈。Neil 可以查看此反馈，并根据反馈改进自己的课程。他可以回复消息，并可以通过多种选项来更改消息状态（已修正、不可操作等）。
通过统计信息和玩法强化课程效果（使用“统计数据”标签）：如果尼尔发布了他的探索项目，并且有其他学员参与了该探索，他将会希望利用学员的互动来改进他的探索方式。他有几种提升课程效果的方式。
他可以创建分支，使其最终引回他之前创建的主分支，从而开始增加探索的复杂性。他可能会为更高级的学习者提供捷径，这样可以避免无聊并提高他们的参与度。他可以考虑使用参数来针对游戏中的特定学习者自定义探索。
添加图片、视频：小尼还可以在创建特定卡片时添加图片、视频和链接。
邀请其他用户加入探索：Neil 可以邀请其他用户加入他的探索活动，并为他们分配以下不同角色：
- 管理者
- 协作者
- 译者
- 游戏测试人员
每个角色都可以控制其下属角色的职能，因此“管理员”角色的功能最多。自从 Neil 创建了这项探索后，他在 Oppia 中担任“经理”一职。
建议的指南（基于用户任务分析）
规划课程
- 创建故事大纲 / 场景
- 设计基于场景的课程结构
- 评估评估方法（包括如何编写练习题）
为课程添加旁白（使用“翻译”标签页）
- 以原始课程语言添加旁白
添加其他语言的旁白
- 翻译卡片中的文字 *录制第二种语言的旁白
有效使用“Stats”（统计数据）、“History”（历史记录）和“Feedback”（反馈）标签
使用图片、视频、链接等设置课程内容的格式
利用统计信息和通关效果提升课程内容
- 向现有课程添加分支
- 为更高级的学习者创建快捷方式
邀请其他用户上课（角色）
- 角色类型及其层次结构
实施步骤
采用的方法：
Oppia 的文档非常适合同时编写书面指南和视频教程（请参阅下面的示例指南部分）。这可满足不同的学习风格，并为用户提供更多学习 Oppia 运作方式的选择。
方案：
该项目将由用户指南和视频教程组成。本指南和视频将涵盖上方“推荐指南”部分中详述的内容，但首个指南“规划课程”不需要视频。这些视频将嵌入到包含用户任务的页面中。
每周里程碑：
开发阶段从 2019 年 9 月 2 日持续到 11 月 22 日。
第 1 周、第 2 周和第 3 周（9 月 2 日至 20 日）：
规划课程（制作故事大纲 / 场景、构建基于场景的课程、规划评估方法（包括如何撰写练习题）
第 4 周（9 月 23 日至 27 日）：
为课程添加旁白
第 5、6 和 7 周（9 月 20 日至 10 月 18 日）：
有效使用“Stats”（统计数据）、“History”（历史记录）和“Feedback”（反馈）标签
第 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 月结束。
通信
联系频率取决于与导师的讨论情况。我更喜欢定期沟通，我的建议是每两周更新一次，并就目前完成的工作获得反馈。不过，这种方法也很灵活，具体取决于导师的偏好。