本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- Kolibri
- 技術文件撰稿者：
- StephDix
- 專案名稱：
- Kolibri 生態系統說明文件樣式和工作流程慣例
- 專案長度：
- 長時間跑步 (5 個月)
Project description
摘要
本文件詳細說明瞭如何落實風格規範及管理工作流程，進而實現 Kolibri 生態系統中記錄的教育平權資訊。
總覽
我的提案包含四個階段。在第一階段，我會完成 LE 說明文件樣式指南，其中包含無障礙指南、書寫和格式建議，並遵循軟體開發中的 LE 概念和樣式指南。在第二階段中，我將對 ReadTheDoc 和 Google Docs 文件進行品質稽核。稽核計畫整合了使用檢查清單，評估是否符合樣式規範。這些檢查清單可協助您記錄發現事項，並將變更套用至文件。第三階段則將建立 ReadTheDoc 和 Google 文件範本的結構、外觀和風格。我會在 Google 雲端硬碟中建立範本和圖片存放區，識別各種主要文件類型範本，以便在日後的實作過程中重複使用。我會在這個工作中建立範本，以便提交文件問題，方便在提取要求審查中識別。最後，我會製作一份「貢獻者指南」，將實用資源分門別類，協助所有協作者，提升大家存取資訊的經驗。
目的和範圍
這項實施計畫的目的，是為了改善使用者使用 Kolibri 文件的體驗，並協助團隊成員和貢獻者製作更優質的文件，以及在社群中進行積極的協作。這項實作適用於 ReadTheDocs 和 Kolibri 生態系統中 Google 文件的子集。
目標對象
主要對象為導入者、管理員和最終使用者，他們是 Kolibri 說明文件最重要的使用者。次要目標對象：團隊成員和協作者，他們會製作及使用 Kolibri 文件。
目標
《Kolibri Ecosystem 說明文件》的風格指南和工作流程系統預期使用者能： 製作容易理解的說明文件，且說明語言一致且版面配置一致。 維護文件的品質。方便使用者在說明文件管道之間存取資訊。強化 Kolibri 開放原始碼社群中的協作計畫。
資訊來源
我參考的資訊來源包括 Kolibri、Kolibri Studio、Kolibri Development RTD 文件，以及 Google 雲端硬碟中的 Kolibri Toolkit。
Radina Matic 是提供暖身活動和專案專屬活動的重要助力，她提供的資訊，包括組織將「指南」和「指引」視為概念，以及有無提供給作者的指南，有助於我整理想法並草擬結論。
軟體
我會在 Google 文件中編寫樣式指南草稿。這個文件平台非常適合在可供發布時進行疊代。針對品質確保稽核，我會使用 Google 表單製作和評估文件。試算表會儲存表單回應以供文件控制使用。我會使用 GitHub 重構 RTD 文件。我曾使用過 Git、Gitkraken、GitHub 和 Gitlab。我熟悉 Markdown 和一些 RestructuredText。我打算協助修正說明文件，以便繼續學習語法。我會使用「Sharex」分享圖片和 GIF。我喜歡這個工具，因為它會以不同的輸出格式算繪。我會使用「圖表」和映像檔版本。圖表軟體可完美整合 Google 文件、Google 雲端硬碟和 LibreOffice。說明文件狀態 在探索階段，我修訂了 Kolibri 的大部分說明文件。我發現全專案的說明文件中，發現文法錯誤、錯字、版面配置不一致、字體排版、圖片使用方式，以及造成說明文件路徑混淆。例如，在 Kolibri 的使用者指南中，疑難排解的部分是次主題，而不是主題。對使用者來說，這些資訊非常重要，因為他們才能從目錄中存取這些資訊。另一個替代方案是使用搜尋列和目錄樹狀圖，展開其他主題並找出疑難排解文章。
如要存取「疑難排解」部分，您必須搜尋該部分，或展開「管理 Kolibri」頁面，才能在說明文件中找到「疑難排解」部分。指南與指南 在本專案提案中，我分析了兩份文件：LE Kolibri 使用者說明文件樣式指南和 LE 翻譯指南。在 LE Kolibri 指南中，我根據自己提出的主題大綱和說明文件計畫，提出建議和意見，並指出指南中需要改善的其他幾個地方。我根據 LE Translation Guidelines (LE 翻譯指南) 中的建議和現有慣例，決定了格式和風格，在分析過程中，我發現許多人對「指南」和「規範」這兩個分類的文件有誤解。
結果
我同時對 LE Translation Guide 進行品質檢查，以及初步的建議和備註，我在品質確保稽核工作中進一步說明瞭詳細資訊。以下是評估結果的最終意見： ICU Syntax .js 網站的連結無法連線 建立這些規範時使用的格式不正確。 本文件為指南，而非指南。不一致的字體排版。使用不正確的標題和標題、不當使用語言和縮寫。不當使用替代文字。重複陳述式/ 指示。
這兩份文件的研究結果均包含在本提案的交付項目中。
特定專案的工作
- LE 使用者說明文件格式指南建議 (註解)
- 新的 LE 翻譯指南樣式和格式。
- 主題大綱
- 專案時間軸
- 文件工作