本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- Mautic
- 技術文件撰寫者：
- Favour Kelvin
- 專案名稱：
- 知識庫
- 專案長度：
- 標準長度 (3 個月)
Project description
摘要
知識庫是集中式存放區，可以儲存、整理及共用資訊。在外部使用知識庫，使用者可以藉此獲得任何與公司產品或服務、機構和產業相關的所有須知事項。相反地，內部知識庫的功用通常是讓社群/使用者能夠協同合作，並在內部發布所有公司知識和資訊。 雖然特定知識庫的內容取決於許多因素，但大致上通常包括如何開始使用特定產品、充分運用進階功能，以及解決常見問題。創作及呈現知識庫的主要優點在於，你不必逐一為目標對象成員/使用者/社群提供深入詳盡的資訊，
Mautic Knowledgebase 集中彙整了 Mautic 和 Mautic 相關的教學課程、使用指南和最佳做法，無論主題是直接 (例如在 Mautic 中做什麼)，還是間接 (例如更一般的行銷策略)，
撰寫本文時，Mautic Knowledgebase 相當全新且不完整，而 Mautic 社群希望透過這項專案，改善為使用者說明文件提供深入與隨選資訊的方式，讓使用者在使用 Mautic 時享有流暢的體驗。瀏覽 Mautic 知識庫提供豐富資訊，但需要更新的教學課程和使用指南，也必須建立新的教學課程和使用 Mautic 3x 版本。
我在閱讀現有說明文件時的第一印象 目前在 https://kb.mautic.org/ 取得了 Mautic Knowledgebase。說明文件中的部分教學課程、使用指南和最佳做法主題不是最新內容，且內容稀疏或不完整，也未涵蓋目前版本的資訊。
為什麼你提議的改善項目比目前的/領域要貢獻一己之力？ 建議的改善措施旨在提升，確保所有使用者的效率、一致性，以及高枕無憂。其中包含編寫的教學課程、使用指南、最佳做法及相關圖片，並且附上操作說明與說明，協助您瞭解如何使用最新、更新、易於瀏覽和理解的內容。
分析
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 文件季別」參賽者的經驗報告。