本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Kolibri
- 技术文档工程师：
- Danielle V
- 项目名称：
- Kolibri 内容工作流
- 项目时长：
- 长时间运行（5 个月）
Project description
以下提案是通过开展研究和与 Kolibri 导师沟通后制定的。与导师的对话帮助我制定了下文中所述的用户角色。此外，通过讨论，我还想到了创建教程代码库/着陆页的想法，以便用户可以根据自己的需求选择要查看的教程。
概览
此提案提出了一个解决方案，用于引导用户完成各种用户历程，即从计算机将内容导入 Kolibri Studio，然后再从 Kolibri Studio 导入 Kolibri。我提议创建一个中央教程库。用户将通过着陆页访问这些教程。该着陆页将提供一个表格，其中包含指向每个工作流教程的链接，并会指明该教程可能对哪类用户有用。这样，教程就会根据用户的需求和能力提供更加个性化的教程。多个课程将演示一个工作流（例如“安装 - 导入”）。每节课都包含一个视频。视频展示了工作流程的一小部分，并演示了这些工作流程如何连接 Kolibri 应用的各个概念。
主要目标
创建教程着陆页，帮助用户确定最适合其需求的工作流。此着陆页将托管在 Read the Docs 平台上。
为每个工作流的组件创建单独的课程，并通过练习来补充难度较高的课程。
为每个工作流创建互动视频。
项目工具
工作将使用屏幕投放软件完成。我使用过 Camtasia，但也使用过价格更低的软件和免费软件。此处链接的示例视频 (https://youtu.be/DkMP_VdGslU) 是使用 Blueberry Software 的 Flashback 制作的，我目前拥有该软件的许可。我将使用 YouTube 创建字幕。教程页面将托管在 Kolibri 的 Read the Document 网站上。草稿工作将在 Google 文档中完成，我可以帮助将文本文件转换为 Markdown 或 reStructuredText，以便制作最终产品。
时间轴
此项目将遵循长期项目指南（总共 26 周，从 2019 年 9 月 2 日到 2020 年 2 月 28 日）。我将每周花大约 10 小时来完成下列目标。除了这些目标之外，在此期间，我还将根据需要参加导师会议和沟通交流。我会与导师一起确定最合适的时间。时间轴通常分为四周的部分，我会在这段时间内制作多个视频、教程页面和练习。
第 1 周和第 2 周
目标：
- 在个人设备上设置访问信息所需的所有网站或账号。
- 开始为着陆页开发结构和更详细的线框图。
- 与导师讨论视频风格，并制作视频片头模板、片名和片尾画面的所有填充音乐，以及应包含的其他信息。
- 查看当前文档和文档结构，提取要用于其他资源和教程参考的链接。
第 3 至 6 周（第 1 级 - 新手教程）
目标：
- 为 INSTALL-IMPORT/Level 1 工作流开发初始内容和课程。创建下载、安装、配置和导入流程的视频。由于 INSTALL-IMPORT 函数是许多其他工作流的基础，也是最常用的函数，因此我们将会花费大量时间来完成这些教程和课程。
- 重点关注“导入”位置类型，并制作一张图形，向用户展示他们可以在哪里获取着陆页的内容（Kolibri Studio 中存在的公开渠道）。
- 制作更多视频和内容，以便扩展 INSTALL-IMPORT（更新频道）。这些扩展内容还可以是其他资源或指向现有文档的链接。
- 为任何视频制作字幕。
- “测试”视频，并向任何可用的资源征求有关易用性的反馈。这包括重新审视视频模板，并为未来的视频确定模板。
第 7 至第 10 周（第 2 级 - 内容上传者）
目标：
- 重点关注与 Studio 上传器角色相关的课程和工作流程视频。
- 有关上传-发布-导入的完整文档和课程。
- 为任何视频开发字幕。
第 11 至第 14 周（第 3 级 - 内容“混剪者”和编辑者）
目标：
- 重点关注以下工作流并创建教程/课程内容：上传-修改-发布-更新和修改-发布-更新。
- 为视频制作任何字幕。
第 15 周至第 18 周
目标：
- 正如我在研究此提案时所说，涉及 Ricecooker 的工作流程优先级较低（CHEFDEV 类型）。根据时间和安排，我可以利用这段时间创建一个高级教程，其中会引用 Ricecooker 的现有文档。
第 19 周至第 22 周
目标：
- 在此期间评估是否有任何遗漏，并测试所有教程的当前流程。
- 着手完善着陆页，并开始将视频关联起来。
- 按照与导师讨论的内容，将在 Google 文档中完成的页面草稿转换为 Markdown 或 reStructuredText。
第 23 周至第 25 周
目标：
- 根据时间，完成低优先级高级教程的所有最终作业。
- 最后一分钟了解 Google 文档页面编辑、文件测试、语法/拼写检查。
- 对视频或其他页面中的所有链接进行质量检查。
第 26 周
长时间运行的项目的最后一周。我将与导师合作，完成项目交付成果并完成所有必要的最终 Google 文档。
教程组件
教程着陆页
用户将访问 Kolibri 的 Read the Docs 网站上的教程着陆页，该页面将简要介绍针对内容工作流提供的各种教程。本页面旨在简要介绍 Kolibri 生态系统，并以图形方式显示各种工作流。这样，用户就可以查看适合其技术需求和组织课程需求的工作流程类型。用户将更深入地了解 Kolibri 和 Kolibri Studio 中可供选择的选项。
教程和课程页面
每个教程首页都会介绍该教程（由多个课程组成），然后介绍一些用户目标。教程会说明整个工作流，并由各个课程组成。每节课都会有视频。视频将涵盖整体概念的各个部分。每节课程都将保留在教程工作流父级页面内的单独页面中。课程页面将包含按钮，供用户前往教程中的上一个或下一个课程。非常复杂的概念可以包含练习活动。
视频和结构
视频将概述单个概念。在屏幕上执行相应操作时，视频将给出指示。如需查看示例视频，请访问 https://youtu.be/DkMP_VdGslU。此示例视频展示了如何使用“设置设施”向导。
该视频使用了宣传信息和突出显示的光标，帮助用户完成单个概念的步骤。视频将托管在 YouTube 上。如果视频托管在 YouTube 上，系统会自动生成字幕。然后，我会修改字幕的拼写、语法和标点。然后，您可以将这些字幕导出，以便在 Amara 或其他翻译工具中进行翻译。
这些视频将采用统一的片头，我计划在前几周与导师讨论这一点。我还将使用一致的宣传信息样式（箭头、光标突出显示、方框），这些样式将在前几周内与导师一起确定。
结构示例
最简单的工作流程是“安装-导入”，本教程将介绍该工作流程。该教程中有两个可能包含视频的课程：
- 下载、安装和设置您的 Kolibri 设备
- 在 Kolibri Studio 中导入内容 - 请注意，其他工作流会引用此视频
更高级的教程需要包含多个子课程和多个视频。UPLOAD-EDIT-PUBLISH-UPDATE 工作流程遵循以下结构。
第 1 课 - 在 Kolibri Studio 中上传内容和创建频道
用户目标：学完本课程后，您将了解如何完成以下操作：
- 在 Kolibri Studio 中创建频道，以便在 Kolibri 中使用。您将了解如何使用频道的 Secret 令牌在 Kolibri 中导入内容频道。
- 通过从工作室内容库中现有公开频道导入内容来创建频道。
- 通过上传计算机中的内容创建频道。
子课程视频：
- 子课程 1 - 在 Kolibri Studio 上创建自己的频道，并从现有公开频道（Khan Academy、PHET 等）导入内容： 视频 1 - 公开内容频道（在 Kolibri Studio 上查看公开频道） 视频 2 - 创建频道 视频 3 - 从现有频道导入内容 视频 4 - 发布频道并获取 Secret 令牌 视频 5 - 使用 Secret 令牌将频道导入 Kolibri
- 子课程 2 -“我的文档”内容渠道上传： 视频 1 - 从“我的文档”上传文件 视频 2 - 创建自己的练习
第 2 课 - 在 Kolibri Studio 中对频道进行高级编辑
用户目标：学完本课程后，您将了解如何完成以下操作：
- 在 Kolibri Studio 中修改内容渠道
- 在 Kolibri Studio 中管理内容渠道
子课程视频：
- 子课程 1 - 通过添加练习、重新整理文件夹结构和协作选项来修改内容（1 个视频）
- 子课程 2 - 使用其他功能，例如删除/移动内容（1 个视频）
第 3 课 - 发布 Kolibri Studio 频道以在 Kolibri 中使用以及更新频道
用户目标：在本课结束时，您将了解如何完成以下操作：
- 在 Kolibri Studio 中发布频道，并在添加新内容后重新发布
- 更新频道
- 获取要导入到 Kolibri 的频道令牌（通过第 1 课中介绍此操作的上一个视频的链接）
子课程视频：
子课程 1 - 向频道发布动态
视频 1：重新发布频道 视频 2：添加其他内容后在 Kolibri 上更新频道