本頁將詳細說明 Google Season of Docs 接受的技術文件寫作專案。
專案摘要
- 開放原始碼組織：
- Mautic
- 技術撰稿人：
- Favour Kelvin
- 專案名稱：
- 知識庫
- 專案長度：
- 標準長度 (3 個月)
Project description
摘要
知識庫是集中式存放區，用於儲存、整理及分享資訊。在外部使用時，知識庫是使用者可以前往的地方，瞭解公司產品或服務、機構和產業的所有相關資訊。另一方面，內部知識庫通常用於讓社群/使用者在內部協作及發布所有公司知識和資訊。雖然特定知識庫的內容會因許多因素而異，但大多會提供如何開始使用特定產品、如何充分運用進階功能，以及如何解決常見問題的資訊。向觀眾建立及呈現知識庫的主要好處，就是你可以立即提供深度資訊和解答給觀眾/使用者/社群，而無須個別提供。
Mautic Knowledgebase 匯集了各種 Mautic 相關主題的教學課程、使用指南和最佳做法，無論是直接 (如如何使用 Mautic) 或間接 (例如更通用的行銷策略) 都值得您參考。
在本文撰寫期間，Mautic Knowledgebase 才剛推出不久，但 Mautic 社群想要透過這個專案來改善向使用者說明文件提供深入和隨選資訊的方式，讓使用者在使用 Mautic 時能獲得流暢的體驗。閱讀 Mautic 知識庫內容相當實用，但需要更新教學課程和操作說明，並建立新的教學課程，以便與 Mautic 3x 版本相符。
閱讀現有說明文件後的第一印象 目前，Mautic 知識庫可在 https://kb.mautic.org/ 取得。說明文件中部分教學課程、操作說明和最佳做法主題未更新，內容較少或不完整，也未涵蓋 mautic 目前版本的相關資訊。
為什麼你認為你的改善建議比目前的做法更優？我們建議的改善方式，旨在提升效率、確保一致性，並讓所有使用者安心使用。這份簡報包含書面教學課程、使用指南、最佳做法及相關圖片，還包含各種數學功能的使用說明和說明，內容包含最新、容易瀏覽且易於理解。
分析
Mautic Knowledgebase 使用 Grav 一般檔案 CMS 和 KLB4 主題來編寫。我研究了許多改善知識庫說明文件的方法
專案目標
- 查看知識庫。
- 更新教學課程和操作說明，以符合 Mautic 3x 版本。
- 為新建立的 Mautic 社群知識庫建立資源
- 編寫一系列教學課程和指南，協助 Mautic 使用者更有效地設定、調整及使用應用程式。
- 更新影片教學課程，以符合 Mautic 3x 版本。
- 移除過時的圖片和資訊。
- 重新撰寫知識庫，讓內容更容易理解。
- 確保知識庫文件的樣式指南/模式正確實作
時間軸
8 月 1 日前
- 繼續為機構貢獻心力。
- 熟悉知識庫說明文件和 Mautic 的最新版本。
- 學習新的技巧和技術寫作技能，有助於實施專案。
社群連結 (8 月 1 日至 9 月 1 日)
- 設定溝通管道和時間 (考量時差)
- 調整我的目標，同時為雙方設下期望
- 進一步瞭解社群和產品
- 與導師和其他機構成員討論建議的文件結構。
- 完成建議的功能以及其他需要對現有說明文件進行的修改。
說明文件期間
- 第 1 週 (9 月 2 日 - 11 月 22 日)
- 在這段期間，我會直接與指導顧問合作，完成以下事項：
- 查看知識庫。
- 更新教學課程和操作說明，以符合 Mautic 3x 版本。
- 為新建立的 Mautic 社群知識庫建立資源
- 編寫一系列教學課程和指南，協助 Mautic 使用者更有效地設定、調整及使用應用程式。
- 更新影片教學課程，以符合 Mautic 3x 版本。
- 移除過時的圖片和資訊。
- 重新撰寫知識庫，讓內容更容易理解。
- 確保正確導入知識庫說明文件的樣式指南/模式。
- 考量開發團隊會忙於處理次要功能的發布作業，因此請考量發布節奏
專案評估 (2019 年 11 月 25 日至 11 月 29 日)
- 提交專案報告和導師的評估
- 撰寫並提交報告，分享自己參與「Google 文件季」的體驗。