WordPress 專案

本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。

專案摘要

開放原始碼組織：
WordPress
技術撰稿人：
dmivelli
專案名稱：
改善 WordPress HelpHub 說明文件中的文章可探索性
專案長度：
標準長度 (3 個月)

Project description

內容提要

WordPress 的人氣也在一分鐘內持續增長。截至 2020 年 7 月初，WordPress 5.4 (2020 年 3 月 21 日發布的最新版本) 的下載次數已達 5,100 萬次。最常使用的語言是英文 (71%)，其次為西班牙文 (4.7%) 和印尼文 (2.4%)。

技術說明文件豐富，是所有說明系統的基礎。經驗豐富的技術作家會將知識融入內容，為使用者提供資訊。使用者會在當下執行對自己有價值或必要的動作。優秀的技術文件撰寫者瞭解，文件內容詳盡明瞭、內容正確，而且能否忠於使用者至關重要。不過，對技術文件撰稿者而言，最重要的因素，例如編輯和製作品質，對使用者來說，重要性可能不如時效性和曝光度。如果使用者找不到精心編寫的說明主題，那麼這類主題又有什麼用呢？

自 2003 年推出以來，WordPress 在開放原始碼領域的成長吸引了開發人員、使用者和貢獻者。原創文章類別和標記需要更新及翻新，才能因應 WordPress 社群的成長與不斷變化的需求。

如果使用者在存取必要文件的路徑感到困惑或受到干擾，則會導致搜尋失敗、失去對產品的信任，甚至可能完全流失。

我們有解決方法。以下是提升曝光度的方法，以及協助使用者找到預期說明文件的做法：

  1. 決定類別標題的樣式
  2. 評估類別標題，確保標題的正確性 (視需要提供更新)
  3. 查看文章，確認分類正確無誤
  4. 為每篇文章定義子類別
  5. 確保沒有搜尋結果會引導使用者前往支援論壇
  6. 注意要刪除的重複或過時主題

WordPress 社群在過去 17 年間已經完成許多卓越的成果，並分享多項成就。更新分類方式並確保使用者歷程準確無誤，因此能持續提升使用者的成長、成功和忠誠度，每月會產生近 7, 000 萬則新訊息，以及 7, 700 萬則新留言。

簡介

作者 Joseph Campbell 定位了「英雄旅程」。在小說中，這個詞指的是結構概念，主角會踏入這個世界，面對並克服挑戰，最後以全新面貌歸來。

在技術說明文件領域，使用者也展開一段旅程：以學習、尋找答案和疑難排解為目標，帶他們找到說明主題。使用者只要能完成這項操作，一切就會順利進行。使用者找不到答案時，就會感到挫折和失望。

但為什麼會發生這種情況？這並非因為編劇偷工減料、不重視或缺乏相關知識。通常是因為技術作家未考量使用者歷程。撰寫者可能全心投入創作優質內容，卻未考量到使用者存取主題的方式。重視使用者歷程至關重要。因此，我們必須思考他們想要知道什麼，以及達到什麼目標。

我與 WordPress 顧問和使用者體驗設計師 Estela Rueda 進行了對談，瞭解這個功能的發展歷程。目前部分標題無法正確描述文章內容。類別會用作標記，但這些類別是在 15 年前建立，因此有些已過時。標記不一致。讓使用者無法順利搜尋答案。

目前情況

WordPress 支援分成九大類別 (開始使用、安裝 WordPress、基本使用情況、基本管理、自訂、維護、安全性、進階主題、疑難排解)。每個類別都包含數個子類別或子主題，可導向文章，每個到達網頁都可能有更多文章。

有熱心且願意合作的 WordPress 內容提供者，可以提供許多主題。不過，由於有許多聲音和觀點，標記和類別就會不一致。

這些主題需要進行現代化，以確保類別符合 WordPress 使用者的當前需求。由於文章超過 200 篇，因此標記和分類的問題已變得相關。

計畫分析

主要目的是審查及重新分類文章，以提升搜尋功能。建議你採取下列步驟：

  1. 與 Mentor Estela Rueda 合作，鞏固相關流程

    • 這是確保詳細資料已確認並達成協議的重要步驟
    • 根據 Estela 的建議，我們會在試算表中追蹤所有建議更新 (Estela 的經驗顯示，最好先收集資料，再提出建議)

  2. 決定並設定類別標題的樣式

    • 建議您使用現在式，為這些類別建立一致的結構，而非動名詞形式 (安裝 vs. 安裝中)，因為動名詞形式 (-ing) 可能會造成英語為第二語言 (ESL) 使用者的困擾，且 -ing 不會為使用者帶來價值
    • 有些類別是單字或雙字詞 (例如「維護」、「安全性」、「基本管理」)，有些則是動名詞片語 (例如「開始使用 WordPress」、「自訂」)，因此我們建議討論如何讓結構保持一致
    • 我一直在研究其他機構如何設定線上協助，之後會與導師討論這件事可能有幫助

  3. 評估類別標題 (並提出更新建議)

    • 這些內容應能符合 WordPress 目標對象的需求，並滿足他們目前的需求
    • 確認這些元素是否一致，並遵循 WordPress 風格指南的標準
    • 確保標題能傳達/解釋意圖
    • 標題應明確說明任何必要的先決條件動作或使用者/裝置狀態

  4. 查看文章/主題

    • 主題是否準確符合 WordPress 目標對象的使用者需求？
    • 主題是否設定正確的背景資訊，或是屬於更大序列的一部分？
    • 步驟是否會區分任務中的不同角色 (使用者、系統/裝置，誰執行哪些操作)？
    • 演員是否清楚區分？
    • 步驟是否將複雜的程序細分為可執行的部分？

  5. 定義及標記子類別

    • 參考使用者故事，並持續新增試算表供日後參考
    • 繼續新增子類別清單，並詳列其路徑

  6. 確保搜尋結果不會將使用者導向支援論壇

  7. 找出重複或過時的主題並刪除，這項鑑識工作有助於提供資訊並簡化使用者歷程

時間軸

2020 年 8 月 16 日

  • 繼續查看 WordPress 說明文件
  • 熟悉 WordPress 說明文件的風格
  • 研究客戶流程的最佳做法，並編入下列說明主題

8 月 17 日至 9 月 13 日

  • 認識 Estela 和 WordPress 社群，並與他們合作
  • 與 Estela 合作，調整專案步驟並建議完成目標
  • 建立包含里程碑和每週工作內容的時間表
  • 與 Estela 設定確認狀態的節奏 (即時應對任何阻礙)

9 月 14 日至 11 月 30 日

  • 與 Estela/導師合作，啟動專案並進行開發工作

12 月 2 日至 5 日

  • 提交最終工作產品報告

12 月 3 日至 10 日

  • 提出專案成功評估與評估，評估與 WordPress 導師和團隊合作的經驗

結論

WordPress 是最熱門的內容管理系統 (CMS)。根據 W3techs 的資料，WordPress 是 37.7% 網站的首選 CMS，因此 WordPress 的 CMS 市場佔比為 63.6%。

憑藉這樣的熱門程度、正確且容易理解的說明文件，我們就必須贏得 WordPress 使用者的核心。

WordPress 能考量使用者歷程，以及用以判斷可能使用者路徑的問題，藉此翻新說明類別和標記功能，有效回答問題並排解問題。這樣一來，WordPress 就能在未來幾年持續吸引滿意的客戶。