本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- WordPress
- 技術文件撰寫者：
- Dmivelli
- 專案名稱：
- 改善 WordPress HelpHub 說明文件中的報導曝光度
- 專案長度：
- 標準長度 (3 個月)
Project description
執行摘要
WordPress 的熱門程度加快了一分鐘。截至 2020 年 7 月初，WordPress 5.4 版 (2020 年 3 月 21 日發布的最新版本) 的下載次數已近 5,100 萬。最常用的語言是英文 (71%)，後面接著西班牙文 (4.7) 和印尼文 (2.4)。
優質的技術文件是所有說明系統的骨幹。經驗豐富的技術作家負責為使用者精通內容，使用者想要執行當下對他們有價值的動作。出色的技術撰寫者瞭解，妥善撰寫的文件必須清晰可辨，而且能站在使用者的角度出發，至關重要。不過，對技術寫作師而言 (例如編輯和製作品質) 對使用者來說最重要的事，其重要性可能低於即時性和可偵測性。如果找不到，那麼最好撰寫的說明主題是什麼？
WordPress 自 2003 年創立以來，一直在開放原始碼領域的成長吸引了開發人員、使用者和貢獻者。原始文章類別和標記需要更新和翻新，才能因應 WordPress 社群的成長與變化需求。
如果使用者前往需要的文件路徑令人困惑或中斷，搜尋失敗、失去產品對產品的信任，甚至可能直接移除。
有解決方法。下列方法有助提升曝光度，並讓使用者獲得預期的文件支援：
- 決定及設定類別標題的樣式
- 評估類別標題，並確保其正確定址主題 (視需要提供更新)
- 詳讀文章並確認分類正確無誤
- 定義每篇文章的子類別
- 確保沒有任何搜尋結果引導使用者前往支援論壇
- 記事重複或過時的主題待刪除
WordPress 社群已完成非凡的成就，並分享過去 17 年的成就。為了更新分類並確保使用者歷程準確無誤，這類使用者每個月建立將近 7, 000 萬則新貼文和 7, 700 萬則新留言，人數成長、成功與忠誠度。
簡介
作者 Joseph Campbell 是「英雄的旅程」這個名詞。在虛構中，這個架構的概念是主角踏上世界的旅程、面對挑戰並克服重重難題。
在技術說明文件中，使用者也會踏上一段旅程，引導自己前往說明主題，目標是學習、尋找答案和排解問題。只要使用者可以達成這項目標，就表示世界上一切都很出色。使用者找不到答案時，會感到沮喪且沮喪。
但為什麼這麼做呢？這並不是因為作家縮減了角落、在乎，或是缺乏相關知識。通常這是因為技術文件撰寫專員不考慮使用者歷程，寫作者可能會全心投入製作優質內容，但並未考量使用者會如何存取主題。專注於使用者歷程至關重要。我們必須考量客戶想瞭解的內容，以及採用的方式。
我與 WordPress 顧問兼使用者體驗設計師 Estela Rueda 對談，他提供了一些歷史。目前，部分標題未能正確描述文章內容。由於類別建立於 15 年前，但有部分已過時，因此類別可當做標記使用。標記不一致。尋找答案的使用者會遇到障礙。
目前狀態
WordPress 支援分為九大類別 (開始使用、安裝 WordPress、基本使用、基本管理、自訂、維護、安全性、進階主題、疑難排解)。每個類別都包含數個子類別或子類別，這些子類別或子類別會導向其他文章，這些類別或子主題可以導向每個到達網頁的更多文章。
由積極合作的 WordPress 貢獻者加入許多好處，就是有許多主題可供參考。不過，在許多聲音和觀點中，標記和分類方式並不一致。
這些主題需要翻新，確保類別能符合 WordPress 使用者的目前需求。目前有超過 200 篇文章，標記和分類的問題變得相關。
企劃書分析
主要目標是檢查文章並重新分類，藉此提昇文章的可搜尋性。建議您採取下列步驟：
與 Mentor Estela Rueda 合作有效改善流程
- 這個重要步驟可確保您確認相關詳細資料並達成共識
- 根據 Estela，我們會在試算表中追蹤所有提議的更新。舉例來說，Estela 的經驗顯示，最適合收集並提出建議。
決定及設定類別標題的樣式
- 我建議針對目前時態中的類別，採用統一且一致的結構，而非以黃金格式 (安裝與安裝) 類別，因為龐德式 (-ing) 可能會使英文困難度成為第二語言 (ESL) 使用者，而 -ing 無法為使用者帶來附加價值
- 某些類別是由一、兩個字組成的主題 (例如維護、安全性、基本管理)，有些則屬大量用語 (例如開始使用 WordPress、自訂設定)，所以您可以討論維持架構的一致性
- 我一直在研究其他機構如何設置線上協助，並與導師討論，看看能帶來哪些助益
評估類別標題 (並提出更新建議)
- 這些元素應能讓 WordPress 目標對象的觀點清楚顯示，且符合客戶目前的需求
- 確認這些圖片一致，並符合 WordPress 樣式指南標準
- 確保標題能傳達/傳達意圖
- 標題應清楚說明所有必要的前置動作或使用者/裝置狀態
評論文章/主題
- 主題是否符合 WordPress 目標對象的使用者需求？
- 主題是否設定正確的背景資訊，還是屬於更大的序列？
- 這些步驟是否能區分任務中的不同演員，例如使用者、系統/裝置、誰？)
- 這些演員是否清楚區分？
- 步驟是否將複雜的程序拆分為可操作的區塊？
定義及標記子類別
- 參考使用者故事，並持續在試算表中新增內容，以供日後參考
- 繼續在子類別清單中加入類別，並詳述其路徑
確保沒有任何搜尋結果將使用者導向支援論壇
記下重複或過時的主題以便刪除；這種鑑識工作將有助於資訊及簡化使用者歷程
時間表
2020 年 8 月 16 日前
- 繼續詳閱 WordPress 說明文件
- 進一步瞭解 WordPress 說明文件樣式
- 研究客戶歷程的最佳做法，深入探討主題
8 月 17 日至 9 月 13 日
- 瞭解 Estela 和 WordPress 社群並與其合作
- 與 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 仍會繼續吸引滿意的客戶。