如何創建用戶手冊：從零到英雄（完整指南）

已發表: 2022-11-24

不確定如何創建用戶手冊來幫助您的客戶從您的產品中獲得更多價值？

用戶手冊是幫助您的客戶（或員工）有效使用您的產品或服務的內容。您還可能看到它被稱為用戶指南、說明手冊、產品手冊等。

除了幫助您的客戶有效地使用您的產品之外，創建高質量的用戶手冊還可以幫助您減少客戶服務和支持請求，因為用戶無需尋求支持即可解決他們的問題。

在本詳細指南中，您將學習如何創建幫助客戶取得成功的用戶手冊。

為了實現這一點，我們將介紹以下所有內容：

不同類型的用戶手冊
在哪裡發布您的用戶手冊
如何創建用戶手冊

讓我們開始吧！

不同類型的用戶手冊

用戶手冊有多種類型，包括面向客戶的內容和內部內容。

在開始之前，了解您想要創建哪種類型的手冊非常重要，因為這會影響您處理內容的方式。

以下是不同類型用戶手冊的簡要總結：

用戶手冊——經典的用戶手冊教用戶如何使用產品。
培訓手冊——培訓手冊教用戶如何執行某項任務或完成某項工作。
操作手冊——操作手冊通常是記錄貴公司運營情況的內部手冊。
服務手冊——服務手冊著重於教導用戶如何在產品生命週期的不同階段正確維護產品。
標準操作程序 (SOP) – SOP 是內部手冊，教導組織成員如何“以正確的方式”正確完成某些流程。

對於下面的說明，我們主要關注創建面向公眾的用戶手冊。但是，以下基本原則適用於任何類型的用戶手冊。

在哪裡發布您的用戶手冊

發布用戶手冊的位置取決於您創建的用戶手冊的類型。

對於面向客戶的用戶手冊，您幾乎總是希望將它們發佈在您的網站上。這樣，用戶可以從任何地方訪問該手冊。

更重要的是，在網絡上發布用戶手冊內容還可以讓您創建比使用物理用戶手冊更友好的用戶體驗，例如添加可點擊的目錄和實時搜索建議。

但是，對於實體產品，您可能還希望將實體用戶手冊作為基於網絡的手冊的補充。

對於內部用戶手冊，您通常希望將它們隱藏起來不讓公眾看到。

實現此目的的一種方法是僅在公司內部網上提供它們。但是，由於有這麼多人在家工作，除非您的公司有自己的 VPN 設置，否則很難做到這一點。

相反，您可以考慮使用密碼保護內容，方法是要求員工登錄用戶帳戶或僅添加密碼以訪問頁面。

對於實體用戶手冊，您可以使用專門的知識管理工具來幫助您發布更複雜的手冊。或者，對於更簡單的用戶手冊，您可以直接在 Google 文檔中編寫並從那裡發布——我們的技術寫作工具集合中有一些有用的工具可以讓您的生活更輕鬆。

要在線發布您的用戶手冊，您可以使用大多數文檔或知識庫軟件。如果您想要一個可以處理面向公眾和內部用戶手冊的工具，您可以考慮 WordPress 的開源 Heroic Knowledge Base 插件。我們將在本教程中更深入地討論這一點。

這是來自 Heroic Knowledge base 的在線用戶手冊示例（以及關於 Heroic Knowledge Base）：

說到教程……

如何通過六個步驟創建用戶手冊

現在您已經了解了一些背景信息，讓我們開始了解如何創建用戶手冊，從零開始，一直到完成用戶手冊。

1. 創建你的用戶畫像

在開始創建任何內容之前，您需要了解內容是為誰準備的，這可以通過創建用戶角色來實現。

您可能已經很清楚您的客戶是誰，但將其寫下來有助於真正集中精力。

為什麼這很重要？

好吧，這是一個例子：

為機械工程師創建技術內容與為非技術用戶創建技術內容之間存在很大差異。

對於大多數產品，差異不會那麼明顯。但了解您的客戶角色仍然很重要，這樣您才能確保您的用戶手冊對實際使用它的人有意義。

2. 確定關鍵問題和目標

一旦您了解了您的客戶是誰，下一步就是了解他們試圖通過您將要創建的用戶手冊實現的目標。

也就是說，閱讀本手冊的人的最終目標（或最終目標）是什麼？

理解這一點很重要，因為您的手冊的目的應該是幫助您的用戶盡可能高效地實現該目標。

在某些情況下，這個最終目標可能是一件具體的事情。例如，如果你有一個社交媒體管理工具，它可能是“在社交媒體上安排一個帖子”。

在其他情況下，它可能是一個更抽象的目標，例如“改進我們的項目管理流程”。

對於較大的產品，用戶可能會嘗試實現多個目標，這將我們帶到下一節。

3.創建邏輯結構和層次結構

現在您了解了您的客戶是誰以及他們想要實現什麼，您可以開始為您的用戶手冊規劃結構。

您想要創建一個結構，使您的用戶從“零”到實現您在上一節中列出的最終目標。

這裡有一些提示可以幫助您做到這一點：

考慮如何幫助客戶盡快開始從您的產品中獲得價值。
從中提取您自己的個人知識。你顯然對你的產品了解很多，但你的客戶不會有那麼多背景知識。
確保涵蓋客戶在嘗試使用您的產品時可能遇到的任何常見問題或令人困惑的細節。這些應該在客戶最有可能遇到問題的時候邏輯地解決。

4. 編寫您的用戶手冊內容

規劃好內容後，您就可以開始寫作了。

根據您的產品/組織的規模，您可以自己編寫所有內容。或者，您可能需要與其他團隊成員協作來編寫內容。

以下是編寫用戶手冊時要考慮的一些一般用戶手冊最佳實踐：

使用模板確保格式一致。創建格式化模板不僅可以加快您的工作速度，還可以確保手冊中的每篇文章與其他文章保持一致。
包括視覺效果（圖像和視頻）以幫助用戶。註釋良好的圖像或 GIF 比單獨的文本說明更有幫助，無論文本多麼詳細和透徹。
使用通俗易懂的語言，避免行話。或者，當行話完全無法避免時，一定要解釋清楚。
簡明扼要。用戶手冊的目標應該是完全涵蓋主題，但要盡可能少。不要遺漏重要信息，但要無情地刪除任何不必要的內容。
盡可能使用項目符號和列表作為說明。使用編號或項目符號列表可以使用戶輕鬆跟踪指南。或者，如果您需要比列表允許的更多細節，您可以為每個步驟製作自己的副標題。
使用主動語態。對於用戶手冊中的說明，被動語態尤其容易混淆。這就是“可以通過按下紅色按鈕打開產品”和“可以通過按下紅色按鈕打開產品”之間的區別。後一個示例（主動語態）更清晰，使讀者更容易將自己置身於說明中。

最後，像新用戶一樣測試您的用戶手冊說明總是一個好主意。

也就是說，一旦您寫完了一篇文章，請返回並實際逐步按照這些說明進行操作，以確保您沒有遺漏任何內容。

5. 發布您的用戶手冊

擁有內容後，上線的最後一步是發布您的用戶手冊，以便您的客戶輕鬆獲取。

如何執行此操作取決於您提供的產品類型。例如，如果您要運送實體產品，您可能希望包含手冊的實體版本。

但是，無論您提供什麼類型的產品，您都希望在線發布您的用戶手冊，以便人們可以輕鬆找到它。

為了幫助您做到這一點，您可以使用知識庫/文檔軟件。

例如，借助 Heroic Knowledge Base WordPress 插件，您可以使用開源 WordPress 軟件發布您的用戶手冊。

這種開源方法讓您完全擁有和控制您的平台，同時仍然提供許多有用的工具來幫助您的客戶更有效地瀏覽您的用戶手冊：

類別組織——您可以輕鬆地將用戶手冊組織成邏輯類別，並使用拖放對這些類別進行排序。
實時搜索建議——如果客戶想直接跳轉到特定的教程，他們可以開始輸入搜索內容，然後根據他們的查詢查看實時搜索建議。
自動目錄——該插件會為每篇用戶手冊文章自動生成一個可點擊的目錄，幫助讀者直接跳轉到與他們相關的部分。
簡單標註/格式- 您可以輕鬆添加標註和其他格式，以引起人們對文章中關鍵元素的注意。
即時回答小工具——除了在您的網站上創建一個專門的用戶手冊頁面外，您還可以添加一個可搜索的即時回答小工具，讓訪問者可以從您網站上的任何地方瀏覽用戶手冊內容。

如果您想查看更多軟件選項來幫助您發布用戶手冊，您可以閱讀我們關於最佳知識庫軟件和最佳文檔工具的帖子。

6. 根據需要更新和修改您的用戶手冊

創建用戶手冊不是一次性的工作。展望未來，您需要花時間修改和更新您的內容。

您可能需要更新用戶手冊的主要原因有兩個：

您向產品添加了新功能或更改了現有功能/界面的工作方式。
您想要改進您的用戶手冊內容以使其更有幫助。

第一種情況很明顯——如果您以某種方式更改產品，則需要更新用戶手冊以說明這些更改。

然而，第二種情況也很重要，需要考慮在內。盡你所能嘗試，你可能不會從第一天起就讓每篇用戶手冊文章都完美無缺。

為了更好地幫助您的用戶，您需要更新和修改性能不佳的手動內容以使其更有用。

如果您使用 Heroic Knowledge Base 等工具發布用戶手冊，它會包含內置的文章有用性評級，以便您可以輕鬆查看哪些文章需要改進。用戶還可以在文章上留下文本反饋，這可以讓您指出文章中沒有提供應有幫助的特定部分：

您還可能缺少用戶遇到問題的主題的文章。為了幫助您找到這些缺失的主題，Heroic Knowledge Base 還包括內置搜索分析，以便您可以跟踪哪些搜索沒有任何主題結果（以及一般的整體搜索）：

立即創建您的用戶手冊

如果您想讓客戶獲得成功，學習如何創建用戶手冊非常重要。

通過這篇文章中的提示和最佳實踐，您現在應該掌握了使用用戶手冊啟動和運行所需的知識。

要以一種簡單的方式在線發布您的用戶手冊並幫助您的客戶瀏覽它，您可以使用 WordPress 和 Heroic Knowledge Base 插件。

Heroic Knowledge Base 可以輕鬆發布您的文章並根據需要組織它們。此外，您的客戶可以利用有用的功能，例如實時搜索建議、自動目錄等。

從今天開始，您很快就會發布您的用戶手冊。

如果您有興趣創建文檔以提高您企業的內部知識，您也可能對我們關於如何為您的員工發布培訓手冊的教程感興趣。