如何構建最佳用戶文檔

如果您的產品比一捲紙巾更複雜，您可能會創建某種用戶文檔來幫助人們學習如何使用它們。

精心製作、用戶友好的產品手冊或用戶指南可能意味著出色的客戶體驗和糟糕的客戶體驗之間的差異。

此外，用戶文檔不僅適用於新用戶。

有經驗的客戶還可以參考用戶手冊或產品指南，以刷新他們不經常使用的功能的記憶或解決他們遇到的特定問題。

在這篇文章中，我們將主要關注為軟件等非物理產品創建用戶文檔的最佳實踐，但這些技巧中的大多數（如果不是全部）也適用於硬件領域。

以下是您將學到的內容：

• 什麼是用戶文檔以及為什麼它很重要。
• 最終用戶文檔如何成為客戶體驗的一部分。
• 良好的用戶文檔如何幫助減輕您的客戶支持團隊的負擔。
• 為什麼視覺內容是最佳文檔的秘訣。
• 確保最佳用戶文檔的基本要素。
• 創建令您的客戶滿意並經受住時間考驗的文檔的四個步驟。

什麼是用戶文檔？

用戶文檔（也稱為最終用戶手冊、最終用戶指南、說明手冊等）是您為最終用戶提供的內容，以幫助他們在您的產品或服務上取得更大的成功。

這些是與您的產品一起提供的指導材料，以幫助人們學會正確使用它，或者——在實體產品的情況下——甚至是組裝它。

如果您曾經組裝過一件宜家家具，那麼您就使用過最終用戶文檔。

但是，用戶文檔有多種形式。

視頻遊戲附帶手冊，告訴您按下哪些按鈕可以射擊壞人。 軟件文檔向您展示了您的購買可以做什麼以及如何做。

稅表附帶如何正確填寫的指南。

割草機和吹雪機有產品指南，向您展示如何啟動發動機以及在何處補充燃料。

跳到如何製作用戶文檔

為什麼用戶文檔很重要？

你知道你的產品很棒。 您也希望您的客戶也知道這一點。 用戶文檔有助於確保您的客戶或用戶真正了解如何充分利用您的產品。

無論是如何保存文檔、啟動電機、使用特定工具，甚至是重要的安全信息，您的最終用戶文檔都是您與客戶關係的重要組成部分。

用戶文檔可以取悅您的客戶

用戶文檔很容易，對吧？ 我的意思是，只要寫一些關於如何使用你的產品的東西，你就可以開始了！

這不是那麼簡單。

它不僅僅是“操作方法”材料。 這是客戶體驗的一部分。 這意味著它也是營銷材料。

作為一名消費者，我經歷過偉大而糟糕的用戶指南。 我敢打賭，你們中的大多數人都有過類似的經歷。

出色的用戶手冊或產品指南向您的客戶表明，您不僅關心他們是否購買您的產品，還關心他們在實際使用產品時是否擁有真正出色的體驗。

覺得您對他們的關心超出了他們的錢包範圍的客戶會不斷地回到您身邊。

如果您希望他們向全世界宣傳他們對您的產品和服務的喜愛程度，那麼提供出色的用戶文檔是購買後體驗的重要組成部分。

用戶文檔如何支持您的支持團隊

人們通常會在出現問題時聯繫您的支持團隊，但他們也可能會在無法解決問題時致電。 擁有出色的用戶文檔可以通過兩種主要方式幫助您的支持團隊。

1. 給他們一個簡單的參考指南

出色的用戶文檔不僅僅需要為客戶服務。 當您的客戶尋求幫助時，您的產品支持團隊可以使用文檔來幫助他們更好地支持他們。 當您包含重要部分（例如目錄或索引）時，他們可以快速找到所需的信息。 而且，如果它是可搜索的電子文檔，那就更好了！ 我們將在本文後面詳細了解這一點。

2. 減少通話

如上所述，當人們無法解決問題時，他們通常會致電支持。 但是，如果客戶能夠自己弄清楚，他們需要幫助的可能性就會小得多。 事實上，超過 70% 的人更願意使用公司的網站尋求幫助，而不是通過電話或電子郵件獲得幫助。

即使是最好的文檔也不會消除所有這些調用，但創建清晰、全面和簡潔的用戶指南和手冊將大大減少支持請求的總體數量。

優秀的用戶文檔的基本要素是什麼？

儘管每個產品都是獨一無二的，並且需要不同的元素來創建真正出色的用戶文檔，但無論如何都需要遵循一些最終用戶文檔的最佳實踐。

出色的用戶文檔應包括：

• 平白的語言
• 簡單
• 視覺效果
• 關注問題
• 邏輯層次結構和流程
• 目錄
• 可搜索的內容
• 無障礙內容
• 好的設計
• 真實用戶的反饋
• 更多資源的鏈接

平白的語言

沒有什麼比閱讀他們無法理解的內容更讓客戶感到沮喪的了。 沒有人願意感到愚蠢，而讓您的客戶有這種感覺的語言肯定無法培養良好的體驗。

盡可能使用簡單明了的語言來幫助您的客戶理解最複雜的概念。

請記住，為用戶而不是開發人員寫作。

這聽起來很簡單，但是用通俗易懂的語言來描述你從前到後都知道的產品或服務比你想像的要困難。 您知道客戶可能不知道的各種行話、首字母縮略詞和其他“內幕”信息。 你使用它是很自然的。

但這就是您可能遇到嚴重麻煩的地方。

不要假設您的客戶對您的產品一無所知。 不要以為他們知道您可能每天在辦公室使用的所有技術和/或行業流行語。

不要像孩子一樣寫作，但要明白他們可能需要額外的幫助才能真正讓他們跟上進度。 以易於閱讀的方式編寫文檔。

簡單

保持文檔盡可能簡單以實現其目標。 這既適用於文檔的內容，也適用於其設計。 長長的文本塊和擠滿了書面和圖形內容的頁面會使用戶指南或手冊感覺令人生畏和不友好。

被您的用戶材料嚇倒的客戶更有可能致電您的支持團隊尋求幫助，而不是嘗試自己解決問題。 此外，他們不太可能擁有良好的客戶體驗。

視覺效果

最好的用戶文檔完美地說明了“展示，不告訴”這句話。

視覺內容，包括圖像、帶註釋的屏幕截圖、圖形和視頻，可以快速向人們展示您的產品是如何工作的。 他們不必閱讀它：他們可以看到它！

TechSmith 最近的研究表明，當提供視覺或視頻內容的指令時，人們實際上更快地吸收視覺信息並更好地執行任務。

視覺內容還有助於分解長文本塊，並有助於消除許多使許多用戶指南或手冊感到恐懼和不愉快的文本。

在用戶文檔中包含視覺內容的流行方式包括屏幕截圖、屏幕錄像、教程視頻等。

你聽說過簡化圖形嗎？ 有時稱為簡化用戶界面（或 SUI），簡化圖形獲取用戶界面或其他圖形的圖像，並且——顧名思義——簡化它們。 這個更基本的版本突出了最重要的信息，同時減少了對簡單形狀不重要的文本和圖形。

所以，看起來像這樣的東西：

現在看起來像這樣：

如果我試圖向某人展示如何選擇“連接移動設備”菜單項，則第二張圖片會消除所有雜亂，並讓客戶的眼睛能夠專注於他們需要的地方。

您可能已經遇到過簡化圖形並且甚至沒有意識到這一點，例如 G Suite 學習中心的這個：

那裡有很多工具，但是如果您正在尋找創建屏幕截圖和屏幕錄像的強大而簡單的方法，我強烈建議您下載 Snagit 的免費試用版。

專注於要解決的問題

每個產品都解決一個問題。 但很多時候，我們非常喜歡我們酷炫的產品功能，以至於我們想做的只是強調它可以做什麼，而不是我們的客戶需要它的原因。

確保向用戶展示如何使用您的產品執行任務。

當然，這將涉及產品功能，但要在幫助用戶了解他們最初購買您產品的原因的背景下突出它們 - 以解決特定問題。

例如，我們的 Camtasia 和 Snagit 教程（是的，教程視頻可以是一種文檔形式）強調了特定的功能，但它們是在為什麼有人可能會使用該特定功能的背景下這樣做的。 這是關於為什麼，而不僅僅是如何。

這是一個很好的例子……

邏輯層次結構和流程

好的文檔需要標題和子標題的層次結構，讓用戶知道每個部分將顯示什麼。 並且該層次結構應遵循邏輯流程，以幫助用戶學習以最有用的方式使用您的產品。

例如，您可能不想通過向客戶展示如何使用更高級的功能而不首先向他們展示您的產品如何工作的基礎知識來開始您的文檔。 首先從簡單的東西開始，然後隨著您的用戶積累知識，向他們展示高級功能。

目錄

目錄為您的客戶提供了一種簡單、有效且熟悉的方式來快速找到他們的問題或問題的解決方案。 它位於文檔的開頭，因此他們無需篩選文本頁面即可找到所需內容。 它應包括上述所有主要標題和小標題。

使其可搜索

曾經有一段時間打印了大多數用戶文檔。 現在，在幾乎每個人都可以使用智能手機的時代，創建電子文檔更有意義。 這並不意味著您也不能創建打印版本，但電子版本提供了許多優勢，我們將在下面更詳細地討論。

就像目錄一樣，可搜索的內容使用戶可以更輕鬆地訪問您的內容，並幫助他們自己找到解決方案。

可訪問性

創建可訪問的內容。 這意味著確保電子文檔符合盲人或視力障礙、耳聾或聽力障礙或可能有認知障礙的人的可訪問性標準。

請記住，您的許多客戶需要它來理解和完全訪問您的用戶文檔。 不要讓他們落後！

好的設計

為您的用戶提供他們想要查看的文檔，他們將更有可能使用它。

設計材料時要考慮到您的客戶。 讓它可用和友好。 避免長段落的文本或內容過於豐富的頁面。 留出空白有助於打破單調，讓學習新產品的前景變得不那麼令人生畏。

包括盡可能多的圖形和圖像來展示而不是告訴您的客戶如何使用您的產品。 對於電子文檔，請使用視頻和 GIF。

在多個文檔中使用一致的字體和互補色。 如果您的組織有樣式指南（如果尚不存在，我強烈建議您創建），請確保您的文檔符合它。

Snagit 模板使從一系列屏幕截圖或其他圖像創建具有專業外觀的用戶文檔變得異常容易。 只需收集您需要的圖像，選擇“創建”，然後選擇“模板中的圖像”，您就可以開始使用了。

Snagit 附帶了一堆免費的、專業設計的模板，並且使用 TechSmith Assets for Snagit，您可以獲得更多！

來自真實用戶和/或 Beta 測試人員的反饋

在您聽取組織外部實際使用產品的人的意見之前，您無法創建真正出色的用戶文檔。

了解他們的痛點並儘力解決它們。 找出他們告訴您需要知道什麼才能最好地使用您的產品。 雖然其中一些看起來很明顯，但我保證你會學到一些你從未考慮過的東西。

其他文檔的鏈接

確保您的客戶可以訪問您組織的更多資源，了解如何使用您的產品取得成功。 對於電子用戶文檔，這可以像提供指向教程、常見問題解答、用戶論壇等的鏈接一樣簡單。

但即使是打印文檔也可以包含網站地址和電話號碼等內容，以提供進一步的支持。

獎金！ 添加分步說明

分步指南有助於避免使用長文本塊，並提供一種更清晰的方式來顯示流程，而不是僅通過文本來解釋它。 與簡單地告訴某人如何完成一項任務相比，它們更易於遵循、更易於理解並提供更加用戶友好的體驗。

請記住，在您的分步說明中包含視覺內容會使它們變得更好。

Snagit 提供了一個易於使用的分步工具，可幫助您創建出色的分步文檔。 此外，組合圖像工具使您能夠將單個屏幕截圖和其他圖像組合成一個圖像，以便於編輯和標記。

如何創建出色的用戶文檔

第 1 步：計劃

每一套優秀的用戶文檔都從一個計劃開始。 這裡有一些關於如何到達你想去的地方的提示。

知道從哪裡開始

許多人認為，如果您了解自己的產品，就可以開始創建文檔。 但還有更多內容。 相反，從一個計劃開始，以確保您實際上是在幫助您的用戶。

在製作文檔之前，需要考慮以下幾點：

• 你應該包括什麼？ 你應該遺漏什麼？ （提示：這是用戶反饋真正有用的地方！）
• 我們應該以什麼順序呈現信息？ （還記得學校的論文大綱嗎？使用它們！）
• 還有哪些其他資源可用？ 我們將如何提供這些訪問/鏈接？
• 誰負責創建文檔？ 誰負責對文檔進行反饋？ 誰有最終批准？
• 這需要翻譯或本地化嗎？

這些問題的答案決定了您創建文檔的方式。 規劃可確保流程順暢和更好的用戶文檔。

了解您的產品

確保您了解您的產品。

這並不意味著您需要成為所有方面的絕對專家，但任何創建用戶手冊或用戶指南的人都應該對產品有實際操作經驗。

依靠您的主題專家獲得更深入的知識，但在嘗試教別人之前，您應該知道如何自己使用它。

選擇你的格式

此外，文檔的最終格式同樣重要。 只會打印嗎？ 會是電子的嗎？ 如果是這樣，它會住在哪裡？

不久前，幾乎所有的用戶文檔都是打印的。 但是，除非您有充分的理由，否則我建議您至少在您的網站上提供電子版本。

大多數用戶可以 24 小時使用智能手機、計算機或平板電腦，而且他們習慣於在想知道的任何時候找到他們想知道的任何東西。 將用戶資源放到網上可以讓他們隨時隨地訪問，這意味著他們不必在抽屜或文件櫃中尋找多年未見的用戶手冊。

此外，讓殘障人士可以更輕鬆地訪問電子文檔。 僅印刷版適用於大多數人，但您準備好為可能失明或視力受損的用戶創建盲文版了嗎？ 對於身體殘疾的用戶，他們很難用手操作物體怎麼辦？

存在使所有人更容易訪問電子文檔的工具，但僅打印版本提供了更困難的可訪問性問題。

此外，電子文檔更容易更新，因為它存在於網絡上。

我應該將我的文檔製作成 PDF 嗎？

如果您想提供可下載的 PDF 版本的文檔，那很好。 但請確保它在您的網站上也以非 PDF 格式提供。

第 2 步：創建您的用戶文檔

一旦您回答了所有問題並做出了上述所有決定，就該創建您的用戶文檔了。 我不會假設告訴您如何準確地為您的特定產品創建文檔，但有一些關鍵事項需要牢記。

• 除非絕對必要（然後一定要定義它們），否則避免使用行話和高度技術性的術語。
• 避免使用首字母縮略詞，除非您解釋它們的含義。
• 盡可能使用公認的寫作風格，例如 AP 或 Chicago。 如果您的組織有公司風格指南，請使用它。
• 不要假設用戶對您的產品或產品的功能一無所知。 向他們展示成功所需的知識。
• 記得使用簡單的語言。 為八年級或以下水平寫作。 即使對於高級讀者來說，簡單的語言也會導致更快的處理和更好的理解。
• 設計應該令人愉悅、不嚇人，並吸引用戶。讓他們想要使用您的文檔。

第 3 步：測試它

只有當用戶指南可以幫助您的客戶盡其所能使用您的產品時，它才是偉大的。 直到有人使用它，你才能知道這一點。 在您的新創造進入整個世界之前，您想對其進行測試。 這裡有一些提示！

• 最佳實踐：將其提供給一組真實用戶或 beta 測試人員，看看他們是如何做的。 將他們的反饋納入完成的文檔中。
• 如果您沒有 beta 測試用戶反饋，請在內部進行測試，最好與最不熟悉產品的員工一起測試。
• 從開發人員和工程師那裡獲得反饋。 他們比任何人都更了解產品，並且可以指出您可能遺漏的東西。

第 4 步：使您的文檔保持最新

當您的產品發生變化時，您需要不斷更新用戶文檔。 如上所述，這使電子文檔相對於印刷具有巨大優勢。 但是，即使是僅打印的文檔也可以更新並在您的網站上可供下載。

請記住，您的內容只有在準確的情況下才是偉大的。 確保您提供給客戶的東西實際上可以幫助他們使用您的產品。

概括

如果您什麼都不記得，請記住，應該以對您的用戶最有幫助的方式創建、設計和呈現出色的用戶文檔。

為他們提供繼續讓他們高興並提供您想要的客戶體驗的文檔。

使您的文檔易於訪問、有用且可視化。

常見問題