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