很棒的用戶文檔的 9 個技巧（附示例）

用戶文檔是交付給客戶的整個產品的重要組成部分。 它可以幫助最終用戶更成功地使用您的產品或服務。

過去，用戶文檔是通過用戶機器本地的幫助文件或物理手冊或小冊子提供的。 這意味著它無法輕鬆更新或更改，並且軟件提供商獲得的關於其內容如何使用的數據非常少。

如今，用戶文檔幾乎總是在線提供，這有助於技術作家在如何幫助用戶方面更具想像力。 他們可以收集數據，嘗試不同的學習技術，更快地迭代，為用戶提供更豐富的內容體驗。

這就是這篇博文的用武之地！ 一世

在這篇文章中，我們將探討您可以做些什麼來改進您的用戶文檔並查看一些優秀的用戶支持內容示例。

從計劃開始

就像生活中的大多數事情一樣，最好從計劃開始，創建用戶文檔也不例外。 這就是為什麼您要確保在開始之前問自己（可能還有那些請求文檔的人）很多問題。

1.考慮你的聽眾

你為誰做這個？ 最終用戶？ 系統管理員？ 此內容是否只會在內部進行審查，還是也會在外部看到？ 您為誰創建用戶文檔有助於構建您共享的信息。

2. 評估並牢記您的最終目標

任何文檔的主要目的都是教你的聽眾一些東西。 在確定誰將使用您的文檔後，您需要決定希望他們從中獲得什麼。

在查看文檔後，您希望您的聽眾能夠執行什麼操作？ 通過牢記該問題的答案，您將能夠為相關任務提供適量的內容。

3. 確保您的用戶文檔易於找到

隱藏的用戶文檔幾乎與糟糕的用戶文檔一樣無用。 確保您創建的用戶文檔對於需要它的人來說很容易找到，這一點很重要。

這不僅意味著確保它是可見的，還意味著用戶可以在您的技術文檔中導航并快速找到他們問題的答案。

您的聽眾越快找到這些答案，他們就會越開心。 它還可以節省您回答有關產品的重要但常見問題的時間。

簡潔有力的文筆

強大的寫作對於出色的用戶文檔至關重要。 但寫作影響的不僅僅是用戶文檔的閱讀或聲音。 它也會影響瀏覽用戶文檔的難易程度。

4.寫描述性的標題和副標題

確保你的標題是有用的，最重要的是，是具體的。 編寫用於回答問題的標題或副標題通常是最好的。 以這種方式構建標題可以讓您的最終用戶更輕鬆地找到他們正在尋找的內容，還可以幫助您編寫直接滿足用戶需求的文章。

Unbounce 在整個用戶文檔中編寫有效的標題和副標題方面做得非常出色。 這使得他們的文檔易於瀏覽。 每篇特定文章都有自己的目錄，這使得找到特定問題的答案變得輕而易舉。

5. 便於瀏覽

以易於掃描的方式提供信息有助於用戶節省時間。 作為人類，我們感謝我們能節省的任何時間。 此外，用戶可能並不確切知道他們在尋找什麼。 這時候易於瀏覽的內容是最有益的。

IBM 通過組織乾淨的目錄並提供相關主題，在使他們的幫助內容易於瀏覽方面做得很好。

6.使其易於搜索

谷歌已經訓練我們找到我們問題的答案就像在搜索框中輸入它們一樣簡單。 您的幫助文檔應該反映這種期望。 如果您的幫助內容不可搜索，那麼它可能不是很有幫助。

Hubspot 深入的知識庫使客戶的自助服務變得容易。

使用視覺效果來提高理解

好的用戶文檔是高度可視化的。 雖然強大的寫作和文本對於出色的用戶文檔至關重要，但當視覺效果也存在時，人們學得最好。

7. 使用帶註釋的截圖

帶註釋的屏幕截圖是在用戶文檔中使用的強大視覺效果。 他們通過準確顯示他們需要採取的步驟來消除用戶的猜測。

使用 TechSmith Snagit 之類的程序，可以輕鬆地將文本標註、箭頭等添加到屏幕截圖中。 例如，您會注意到我在這篇博文中使用了我用 Snagit 製作的帶註釋的屏幕截圖。

如果您受到啟發，您甚至可以嘗試 Snagit 的 Step Tool，它允許您通過在指向和單擊時放置有序標註來識別圖像的各個部分。 每次單擊以添加另一個步驟時，數字會自動增加。

一家在文檔中利用屏幕截圖功能做得非常出色的公司是 Asana。 在他們出色的用戶文檔中，他們使用帶註釋的屏幕截圖來清楚地指導客戶。

8.利用視頻展示而不是告訴

視頻很好地展示了一個過程。 許多很棒的用戶文檔結合了視頻的力量和文字說明。 例如，使用短視頻快速完成流程是一種很好的做法。

然後，在視頻旁邊，您可以提供文本分步指南供用戶在自己嘗試該過程時參考。 這樣，如果他們只需要快速提醒，他們就不必一遍又一遍地觀看視頻。

在我們的 TechSmith 產品教程中，我們使用主視頻來完整概述我們正在討論的功能或主題。 然後，在視頻下方，我們提供了帶有屏幕截圖或動畫 GIF 的片段，以重申視頻的要點。

9. 展示示例和最終結果

用戶需要知道成功完成每項任務的樣子。 向用戶提供示例最終結果的屏幕截圖是向觀眾展示理想結果的好方法。

出色的用戶文檔使最終用戶可以輕鬆找到問題的答案，從而創造快樂、滿意的用戶。

創建出色的用戶文檔的一個關鍵部分是提供清晰、易於掃描的信息。 屏幕截圖、視頻或動畫 GIF 等視覺效果都是與您的用戶更有效地交流的好方法。