本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- Mautic
- 技術撰稿人：
- Swati Thacker
- 專案名稱：
- 檢查及更新 Mautic 的使用者說明文件
- 專案長度：
- 標準長度 (3 個月)
Project description
我查看現有說明文件後的第一印象：
目前的說明文件內容冗長，許多地方重複、不完整且雜亂，可能會讓使用者難以找到所需資訊。
身為第一次使用，我不清楚 Mautic 的不同元素 (例如廣告活動、素材資源、訊息、類別等) 如何彼此搭配運作來滿足業務需求。建議您建立高層級概念主題，以 2 到 3 行說明每個 Mautic 元素。本主題可連結至各個元素的各種詳細工作主題。
您可以擴充貢獻指南，加入更多資訊，例如如何開啟問題、如何建議新內容/想法、回報錯誤/問題/安全漏洞等，並提供論壇、Slack 頻道和 Git 存放區的連結。此外，樣式指南也需要擴充，以便新增標準的排版慣例、圖片和表格等指南。
此外，電子郵件、廣告活動中還有許多不完整的資訊，以及需要更新的舊資訊/過時資訊。
我想貢獻的領域：
在查看 Slack 頻道上的討論內容時，我發現使用者會直接與 Mautic 社群互動，因此我意識到廣告活動和電子郵件是 Mautic 的重要元素。我使用 Mautibox 進行第 3 版的測試，並檢查了廣告活動的說明文件，發現需要大幅改版。以下是我發現的一些問題，以及針對每個問題提出的建議：
- Mautic 使用者在建立廣告活動時，可以選擇多種動作、決策和條件。說明文件缺少許多操作和決策，但幾乎沒有廣告活動條件的說明文件。我們需要找出缺少的資訊，並在使用者文件中補上。
- 您可以建立簡單或高度複雜的廣告活動。對於首次建立廣告活動的使用者而言，目前的說明文件並沒有太多價值。建議您找出一些使用案例 (簡單和複雜皆可)，並建立範例工作流程 (以逐步教學課程、最終使用者指南中的主題或操作說明影片的形式)，讓初次使用者在開始建立自己的廣告活動前參考。
- 您需要在本節中以更有條理和有序的方式呈現資訊。必須遵循以任務和概念為基礎的方法來提高可用性。主題可以使用表格呈現動作、決策和條件的相關資訊。「使用日期觸發條件」這個主題似乎不太理想。可在「條件」下方巢狀排列。
除了廣告活動之外，我也針對電子郵件測試了說明文件與使用者介面。我提議的工作如下：
- 電子郵件動態內容適用於自訂程式碼電子郵件範本 (適用於範本電子郵件和區隔電子郵件)，但目前沒有相關說明文件。詳細說明動態內容的功能和設定方式，並附上幾個範例。
- 新增監控電子郵件的專屬主題。這可能包括如何使用資訊主頁上的電子郵件小工具，以及如何追蹤電子郵件相關指標和活動。此外，請將追蹤電子郵件相關資訊移至這裡。
- 說明文件並未明確指出聯絡人回覆、退信管理和郵件傳送者是擁有者，都是可在「電子郵件設定」下設定的全域設定。所有電子郵件設定都應歸類於某個主題。此外，許多其他電子郵件設定 (例如預設頻率規則、取消訂閱設定) 也完全沒有記錄。指出哪些設定為必要或選用。
- 請在 Bounce 管理頁面中移除所有 Webhook 相關資訊，並將其放入專屬的 Webhook 主題中。我們可以在這裡提供該主題的連結。
此外： - 資訊主頁主題中可用的小工具不完整。這項資訊非常重要，必須加入，才能協助使用者分析及監控 Mautic 資源。
您必須檢查整份文件，才能找出缺漏之處。因此我們必須翻新，才能讓使用者更平易近人。
我認為自己的知識/經驗對這項專案有何助益？
在過去一個月內，我處理了 Mautic 說明文件中的各種問題，包括為最新的 Mautic 3.0 版本新增支援功能，因此我已熟悉使用者說明文件的結構，並找出說明文件中的缺失部分。我花了一些時間研究其他行銷自動化工具的說明文件，並將這些文件與 Mautic 使用者說明文件進行比較，瞭解如何填補說明文件中的空白。我對 HTML 語言、開放原始碼工具與相關程序的熟悉程度，是創造更多優勢。 我目前正在進行使用者體驗研究課程，可以運用這些原則來製作更符合使用者需求的說明文件。此外，我有豐富的資訊架構經驗，因此能整理內容並提出構想，讓我們的文件與使用者目標保持一致。此外，我很擅長擴展新技術領域的知識。我擁有 10 年的技術文件撰寫經驗，過去曾有 GSOD 經驗，在首次接觸技術領域的機構成功完成專案時，我相信自己將能助我為 Mautic 說明文件所做的努力。