本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- Mautic
- 技術文件撰寫者：
- Swati Thack
- 專案名稱：
- 詳閱並更新 Mautic 的使用者說明文件
- 專案長度：
- 標準長度 (3 個月)
Project description
查看現有說明文件時，我第一次曝光：
目前，這些文件內容在許多地方都很冗長、內容不完整且出現失調，導致使用者難以找到所需資訊。
我們一開始並不瞭解 Mautic 中的廣告活動、素材資源、訊息、類別等不同元素如何相輔相成，進而解決業務需求。我提議以 2 到 3 行程式碼介紹每個 Mautic 元素的高階概念主題。這個主題可以接著連結至每個元素的詳細工作主題。
並可進一步提供更多資訊，例如如何開啟問題、如何建議新內容/構想、回報錯誤/問題/安全漏洞等，或是提供論壇、SSL 管道和 Git 存放區的連結。此外，樣式指南需要展開，才能新增標準字體排版慣例、圖片、表格規範等。
而且，電子郵件、廣告活動和過去/過時的資訊相當不完整，有需要更新。
我有興趣的部分地區：
在 Slack 頻道上的討論中，當使用者直接與 Mautic 社群互動時，我發現廣告活動和電子郵件是 Mautic 的重要元素。使用 Mautibox 第 3 版時，我測試了廣告活動的說明文件，發現需要進行大量調整。以下是我發現的一些問題，以及我對每個問題的提案：
- 在建立廣告活動時，Mutic 使用者可以選擇不同的動作、決策和條件。許多動作和決策皆缺少相關說明文件，但幾乎沒有任何廣告活動條件的說明文件。我們需要識別缺少的資訊，並新增至使用者文件。
- 廣告活動可能簡單或十分複雜。目前的說明文件無法為首次建立廣告活動的使用者創造更多價值。我提議找出一些應用實例 (包含簡單和複雜) 及建立範例工作流程 (以逐步教學課程的形式，或是使用者指南或逐步操作說明影片)，讓初次使用者開始製作自己的廣告活動前參考。
- 您需要在本節中以更井然有序且有序的方式呈現資訊。必須遵循任務和概念導向的做法，以便提高可用性。主題可以使用表格來呈現動作、決策和條件的相關資訊。「使用日期觸發條件」主題有點過時，你可以在「條件」下建立巢狀結構。
除了廣告活動之外，我也測試了「電子郵件」說明文件對使用者介面的相容性。我提議採用下列做法：
- 電子郵件的動態內容適用於自訂程式碼電子郵件範本 (範本電子郵件和區隔電子郵件)，但目前沒有相關說明文件。說明動態內容的功用和設定方式，並提供一些範例。
- 為 Monitoring 電子郵件新增另一個主題。包括如何使用資訊主頁中可用的電子郵件小工具，以及如何運用小工具追蹤電子郵件相關指標和活動。順帶一提，請將追蹤電子郵件的相關資訊移到這裡。
- 說明文件並未明確指出聯絡人回覆、退信管理、郵件是擁有者。您可以在「電子郵件設定」中調整全域設定。所有電子郵件設定都應該在單一主題下。此外，許多其他電子郵件設定 (例如預設頻率規則和取消訂閱設定) 都不會記錄在文件中。指出必要或選用設定。
- 在「跳出管理」頁面中，移除 Webhook 的所有相關資訊，然後將 Webhook 放在另一個主題中。隨後即可從這裡提供該主題的連結。
此外： - 資訊主頁主題關於可用的小工具資訊不完整。您必須新增這些資訊，以協助使用者分析及監控 Mautic 資源，才需新增。
整份文件都必須加上標記才能辨別落差。我們需要翻新文件，讓使用者更容易理解文件內容。
我覺得自己的知識/經驗對這項專案有幫助嗎？
解決 Mautic 說明文件中的各種問題 (包括為過去一個月發布的最新 Mautic 3.0 版本新增支援) 後，我便充分瞭解使用者說明文件的架構，並找出說明文件中的缺漏之處。我花了時間研究其他行銷自動化工具的說明文件，並與 Mautic 使用者說明文件比較，藉此瞭解如何在說明文件中填補不足之處。 我熟悉 HTML 語言、開放原始碼工具和程序能帶來其他優勢。我目前正在進行使用者體驗研究的課程，並運用這些原則來製作更符合使用者需求的說明文件。此外，我也會運用資訊架構的經驗整理內容，並提出一些想法，確保文件符合使用者目標。 此外，我也負責增加對新技術領域的知識，我擁有 10 年的技術寫作經驗，過去曾有過 GSOD 的經驗：在我從未接觸的技術領域中，成功為貴機構完成專案。我相信我一定能對 Mautic 說明文件做出的貢獻。