本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- Kolibri
- 技術文件撰寫者：
- Danielle 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 週
目標：
- 設定個人裝置，並納入任何需要存取資訊的網站或帳戶。
- 開始製作結構及更詳盡的到達網頁版面配置。
- 除了與導師討論影片的風格外，也請製作影片開場畫面範本、標題和片尾的補白廣告，以及應加入的額外資訊。
- 查看目前的說明文件和說明文件結構，以擷取要用於其他資源和教學課程參考資料的連結。
第 3 週課程 (第 1 級 - 新手教學課程)
目標：
- 為 INSTALL-IMPORT/第 1 級工作流程撰寫初始內容和課程。為下載、安裝、設定和匯入程序建立影片。由於 INSTALL-IMPORT 函式是其他許多工作流程的基礎，也是最常使用的功能，因此我們將投入大部分時間來完成這些教學課程和課程。
- 著重於匯入位置類型，並製作示意圖，讓使用者知道哪裡可以取得所需的到達網頁內容 (Kolibri Studio 中有公開頻道)。
- 製作更多影片和內容，以擴大「INSTALL-IMPORT」(更新頻道) 使用者。並以其他資源或現有說明文件連結的形式提供擴充內容。
- 為任何影片提供字幕。
- 進行「測試」影片，並詢問有關可用性的任何可用資源。做法包括重新審視影片範本，並改進日後影片的範本。
第 7 週到第 10 週 (第 2 級：內容上傳者)
目標：
- 聚焦於工作室上傳者人物角色的課程和工作流程影片。
- 完成 UPLOAD-PUBLISH-IMPORT 的說明文件和課程。
- 為任何影片製作字幕。
11 週至 14 週 (第 3 級 - 內容「Remixer」和編輯)
目標：
- 著重於以下工作流程，並建立教學課程/課程內容：UPLOAD-EDIT-PUBLISH-UPDATE 和 編輯-發布 LISH-UPDATE。
- 為影片製作字幕。
《第五週穿越了八週》
目標：
- 如同我針對此提案研究中所提供的資訊，涉及 Ricecooker 的工作流程優先順序較低 (CHEFDEV 類型)。我可以根據時間和時間，建立概略教學課程，參照 Ricecooker 現有的說明文件。
第九週到二十二間
目標：
- 評估目前的變化，並測試所有教學課程目前的流程。
- 完成到達網頁的最終連結，並著手連結影片。
- 依輔導員討論，將 Google 文件中的網頁草稿轉換成 Markdown 或 reStructuredText。
2 週 3 到 20 度
目標：
- 請視時間而定，完成所有低優先順序的進階進階教學課程。
- 最後 1 分鐘閱讀 Google 文件頁面的編輯、檔案測試、文法/拼寫檢查功能，
- 確保影片內或其他網頁的任何連結的品質。
第 22 週 - 第 2 週
長期執行專案的最後一週。我會與導師一起總結專案交付項目，並填妥所有必要的 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 建立自己的頻道，並匯入現有的公開頻道 (Khan Academy、PHET 等) 的內容： 影片 1 - 公開內容頻道 (在 Kolibri Studio 觀看公開頻道) 影片 2 – 建立頻道 影片 3 – 匯入現有頻道的內容 影片 4 – 發布頻道並取得秘密符記 影片 5 – 使用秘密權杖將頻道匯入 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 的頻道