本頁詳細說明 Google 文件季度接受的一項技術撰寫專案詳細資料。
專案摘要
- 開放原始碼組織：
- 美學
- 技術撰稿人：
- Swati Thack
- 專案名稱：
- 詳閱及更新 Mautic 的使用者說明文件
- 專案長度：
- 標準長度 (3 個月)
Project description
查看現有文件時，我的第一次印象：
目前，這份說明文件充斥著大量冗餘，且內容不完整又不公平，可能會導致使用者難以找到所需資訊。
身為初次使用，我不清楚廣告活動、素材資源、訊息、類別等各種 Mautic 元素如何搭配運作，來解決業務需求。我提議一個概略的概念主題，以 2 到 3 行說明每個 Mautic 元素。這個主題還可以連結至各個元素的各種詳細工作主題。
您可以進一步提供更多資訊，例如如何解決問題、建議新增內容/構想、回報錯誤/問題/安全漏洞等，並提供論壇、Sliack 管道和 Git 存放區的連結。此外，樣式指南也必須擴充，才能新增標準的字體排版慣例、圖片、表格等規範。
此外，電子郵件、廣告活動以及過時/過時的資訊都有些不完整，需要更新。
我想貢獻內容的區域：
在使用 Slack 頻道討論的情況下，使用者直接與 Mautic 社群互動時，我發現廣告活動和電子郵件是 Mautic 中不可或缺的要素。我使用 Mautibox 版本 3 測試了廣告活動說明文件，發現這項工具需要進行大規模的翻新。以下是我發現的一些問題，以及我針對每個問題提出的提案：
- Mautic 使用者可以在建立廣告活動時選擇各種動作、決策和條件。許多操作和決策都缺少相關文件，但幾乎沒有廣告活動條件的說明文件。我們需要找出缺少的資訊，並將其加進使用者文件。
- 廣告活動可能簡單或非常複雜。目前的說明文件無法為初次建立廣告活動的使用者帶來太多價值。我建議你找出一些使用案例 (無論使用或複雜)，然後建立範例工作流程 (包括逐步教學課程、使用者指南或逐步操作說明影片中的主題)，方便初次建立自己的廣告活動前參考。
- 所需資訊需要更井然有序且有條理的方式，在這個部分展示。為了提升可用性，請務必遵守以任務和概念為主的做法。主題可以使用表格呈現動作、決策和條件的相關資訊。「使用日期觸發條件」主題似乎有誤，你可以在「條件」底下建立巢狀結構。
除了廣告活動之外，我也測試了電子郵件說明文件，針對使用者介面。我提議的事項如下：
- 電子郵件的動態內容適用於自訂程式碼電子郵件範本 (適用於範本電子郵件和區隔電子郵件)，但目前沒有相關說明。詳細說明動態內容的功用和設定方式，並提供一些範例。
- 為 Monitoring 電子郵件新增個別主題。其中包括資訊主頁中電子郵件小工具的使用方法，以及如何運用小工具追蹤電子郵件相關指標和活動。也請將追蹤電子郵件的相關資訊移到這裡。
- 本說明文件並未明確指出聯絡人回覆、退信管理、郵件為擁有者，而是可在「電子郵件設定」之下調整的通用設定。所有電子郵件設定都應置於綜合主題下方。此外，其他許多電子郵件設定 (例如預設頻率規則和取消訂閱設定) 則完全不記錄。說明哪些是必要或選用設定。
- 在「跳出管理」頁面中，移除 Webhook 的所有相關資訊，然後將其加入 Webhook 的獨立主題中。以便我們在此提供該主題的連結。
除此之外： - 資訊主頁主題含有完整的可用小工具資訊。這項資訊十分重要，因此必須新增，方便使用者分析及監控 Mautic 資源。
整份說明文件皆需加上標記以找出落差。我們必須翻新這份文件，讓使用者更容易閱讀這份文件。
我期望我的知識/經驗能夠為這項專案帶來什麼好處？
努力解決 Mautic 說明文件中的各種問題 (包括在過去一個月新增對最新版 Mautic 3.0 的支援) 後，我已熟悉使用者說明文件的結構，也能夠找出說明文件中的缺口。我花了時間研究其他行銷自動化工具的說明文件，並與 Mautic 使用者說明文件對照，藉此瞭解我們該如何填補說明文件中的這些缺口。 我熟悉 HTML 語言、開放原始碼工具和程序是一大優勢。 我正在修習使用者體驗研究的課程，可以運用這些原則製作更符合使用者需求的文件。此外，憑藉我在資訊架構方面的經驗，我就能整理內容並提出想法，確保說明文件符合使用者目標。 此外，我擁有學習新技術領域的知識，憑藉過去 10 年的技術寫作經驗，以及之前的 GSOD 經驗，在我從未接觸過的技術領域中，為機構完成一項專案，我一定能做出正義，爭取自己對 Mautic 說明文件的貢獻。