使用說明書:概述、類型和編寫方法

已發表: 2023-04-25

遇到問題時,大多數買家在聯繫您的支持團隊之前所做的一件事就是閱讀您的說明手冊。

但不幸的是,許多企業延遲編寫這些文檔,直到產品完全開發。 這是一個巨大的錯誤。

理想情況下,您應該在產品開發的初始階段開始準備這些手冊。 這樣,您就可以記錄下可能會造成麻煩的所有細節和小問題。

因此,本指南將介紹什麼是說明手冊、它們為何重要、它們的類型以及製作它們的步驟。 讓我們開始吧!

什麼是使用說明書?

說明手冊,也稱為用戶指南或用戶手冊,是傳達技術、工程、科學或其他技術知識以幫助客戶使用產品、設備或解決方案的重要文檔。

每次你聽到“使用說明書”這個詞時,它都會出現各種系列的圖像說明,內容涉及如何操作小工具、組裝家具、修理硬件以及對機器進行定期維護。

例如,查看有關 Windows 截圖工具的 Microsoft 用戶指南。

微軟關於如何使用 Windows 截圖工具的用戶手冊

幾乎每一種產品,無論是實體產品還是數字產品,都附帶用戶手冊,讓客戶快速熟悉它。 該手冊包含有關流程、基準、規則、常見問題和功能的全面詳細信息。

此外,用戶通常不會查看用戶手冊的每一頁。 因此,它通常包括一個目錄或索引,以允許買家導航到與他們的問題相關的確切信息。

另一點需要注意的是,如今用戶指南既有紙質版也有電子版。 但在線說明手冊更受歡迎。 事實上,Statista 的一項民意調查發現,88% 的用戶希望企業提供在線自助體驗。

Statista關於客戶自助服務偏好的調查
圖片來源:Statista

主要原因是方便。 用戶可以在任何地方用手機或電腦在網上閱讀這些文件。 這也使得很難放錯指南。

為什麼使用說明書很重要?

一份寫得好的使用說明書是產品開發的核心組成部分,它直接影響客戶的滿意度。 有時,企業也可能需要遵守法律要求。

用戶手冊的價值經常被低估。 儘管如此,每當我們努力組裝一件家具或嘗試配置特定的小工具時,結構化用戶指南的重要性就會變得顯而易見。

為確保客戶體驗沒有問題,用戶手冊必須成為產品生命週期的核心組成部分。 事實上,Emerald Insight 的產品和品牌管理雜誌 2019 年的一份報告發現,良好的說明對客戶滿意度有積極影響。

這些文件屬於最頻繁和最重要的技術交流部分。 每次購買電器或產品時,用戶指南通常都捆綁在一起。

在某些情況下,法律甚至需要它們才能讓企業向消費者推銷其產品。

使用說明書的種類有哪些?

指導手冊的類型有產品手冊、培訓手冊、服務手冊、操作手冊、組織政策手冊和標準操作手冊。

當您考慮編寫技術文檔時,必須考慮各種用戶指南。

產品/用戶手冊

用戶手冊包括向客戶展示產品如何工作以及如何充分利用它的主要步驟。

培訓手冊

培訓手冊是解釋如何執行任務、程序或任務的一系列指南。

服務手冊

服務手冊是為客戶提供的關於在其整個生命週期的各個階段維護特定設備的說明的集合。

操作手冊

操作指南是一本手冊,其中包含您的企業關於職位、職責和操作的知識。

組織政策手冊

這種類型的說明手冊記錄了組織的協議、流程和標準實踐。

標準操作程序 (SOP) 手冊

標準操作程序為公司員工提供了有關標準工作流程步驟的直接指導。

如何製作使用說明書?

要創建說明手冊,您必須設定目標、計劃和收集內容、讓主題專家參與、選擇吸引人的設計、編寫手冊、確保可瀏覽的結構、添加視覺效果、發布指南並保持最新.

有效的說明手冊可為客戶提供快速而深入的解決方案,以解決他們可能對您的產品提出的疑問。 以下是製作用戶指南的步驟,您的買家肯定會覺得有幫助。

設定手冊的目標

設定一個明確的目標,以確定適合您的說明手冊的內容和設計。 弄清楚用戶將使用手冊獲得的結果。

要開始編寫實用指南,您需要一個具體的目標。 每本用戶手冊都旨在為客戶的關注提供解決方案。 您必須確定此問題才能製作真正有用的用戶指南並解決該問題。

通常,目標是展示產品或引導人們完成使他們能夠完成任務的過程。

另外,每個用戶手冊都應該有一定的結果。 如果你能弄清楚這一點,你就可以更明智地選擇它的材料和佈局。

例如,Sharkninja 的壓力鍋和空氣炸鍋包括一本非常實用的用戶手冊,其目標不僅僅是幫助客戶安裝。 它還包括烹飪說明和許多食譜的詳細信息,以幫助用戶充分利用該產品。

Sharkninja 的用戶手冊超出了它的目標

計劃並收集手冊的內容

收集所有必要的信息。 闡明您希望在說明手冊中涵蓋的內容,以避免讀者被信息淹沒以及任何混淆。

要製作高效的說明手冊,重要的是要清楚地了解您打算放入其中的信息類型。

您應該了解要包含在用戶指南中的主題,以防止讀者被過多的知識淹沒。

收集並合併所有必要的材料、清單和程序。 確保您詳細介紹了每個方面,並擁有編寫手冊所需的所有資源。

考慮你的聽眾

創建一個用戶角色,從他們的角度開始思考,並確定要包含在手冊中的內容。 此外,進行研究以了解他們如何與您的產品互動。

在編寫用戶指南時,必須從您的角度切換到在沒有任何經驗的情況下使用您的產品的買家的角度。

只有牢牢掌握買家是誰以及他們使用您的產品或服務的主要方式,您才能編寫出成功的用戶指南。

識別您的讀者還有助於決定說明手冊中所涵蓋信息的範圍和呈現方式。

以這個基本的 Hydro Flask 手冊為例。 在一個頁面中,它涵蓋了 Hydro Flask 用戶需要的所有基本細節。

Hydro Flask 的說明手冊,其中包含為客戶提供的關鍵信息

因此,關鍵的一步是準確確定您的受眾群體。 您可以從確定他們的特徵、需求和痛點開始。

它還有助於了解讀者對主題的了解、他們對掌握新知識的總體開放程度以及他們吸收信息的方式。

除此之外,調查您的客戶如何與您的產品互動。 準確找出客戶在與您的產品交互時遇到的問題或目標。 您可能需要將客戶分為不同的類別,因為不同的客戶使用該產品的動機各不相同。

讓主題專家參與

作為一個團隊工作,並根據每個團隊成員的專業知識為他們分配角色,這樣您就不會錯過或提供不准確的信息。

創建說明手冊是一項具有挑戰性的任務,您不能掉以輕心。 您產品的用戶依賴於用戶指南中提供的知識,因此期待您的支持。

避免忽視或不准確地傳達基本細節的一種有效策略是尋求產品經理和工程師等專家的幫助。

您可以召集您的同事並開始團隊合作編寫手冊。 例如,一個人可以負責創建用戶手冊。 然後其他人可以對其進行評估,幫助構建細節,並為文檔開發視覺輔助工具。

確定手冊的結構

根據您的用戶可能搜索的內容將您的手冊分成不同的部分。 您還可以使用標準模板使您的文檔更加一致。

在這裡,您以各種段或部分的形式定義指南的結構。 考慮根據您的客戶可能查找的內容將其劃分為子主題。

確保用戶指南遵循邏輯順序,並包括從頭到尾的每一個詳細過程。

例如,這裡是 Adob​​e 關於在不同場景中創建文檔的 FrameMaker 手冊。

結構井然有序的 Adob​​e FrameMaker 手冊

以不會讓用戶感到困惑的方式安排內容,並且採用易於理解的格式。

在所有手冊中保持相似結構的一個好方法是創建模板集合。 您的模板必須簡單明了,流程流暢,並包含每種類型手冊所需的必要元素。 例如,一個模板可以包括:

  • 開頭段落的空間
  • 標題和副標題
  • 按正確順序進行的一系列動作
  • 注意事項和警報
  • 最後想法的佔位符

編寫使用說明書

輸入清晰簡潔的說明,以幫助您的客戶熟悉您的產品或快速解決他們的問題。 在提供可操作的步驟時使用編號列表,並切中要點。

在這個階段,您必須坐下來開始起草您的手冊。 請記住,說明手冊的主要目標是讓您的用戶完成任務並解決問題。

因此,提供快速、簡潔和明確的說明,讓您的買家熟悉您的產品並找到解決產品周圍問題的方法。

始終如一地採用數字步驟並使材料簡短是創建高質量用戶指南的關鍵方面。

為了簡化此過程,請考慮使用強大的編輯工具。 以英雄 KB 為例。 其強大而簡約的編輯器讓您可以起草用戶手冊,而不會被不必要的圖標和窗口所打擾。

Heroic KB 的編輯器編寫用戶指南

使用通俗易懂的語言

使用清晰、簡單的詞語,避免使用複雜的語言。 寫簡短的句子,如果您使用技術術語,請對其進行定義或包含指向詞彙表的鏈接。

在創建說明手冊時避免使用花哨的語言。 您的內容必須直截了當、簡單明了且易於理解。

例如,查看本用戶手冊,其中包含用主動語態編寫的簡單說明。

簡單語言的用戶指南示例
圖片來源:Instrktiv

使用簡單的單詞和簡短的句子來確保材料的可讀性。 引用技術術語時,請確保對其進行解釋或包含其定義的 URL。

確保可掃描的結構

制定清晰的說明手冊內容大綱,並使用易於遵循的佈局和邏輯信息流來指導客戶。

用戶指南不是故事書。 它們服務於一個具體的目的,而不是為了娛樂或休閒閱讀。 用戶可以參考他們的實際步驟,了解如何使用您的產品或在出現問題時解決問題。

沒有人會從頭到尾研究用戶指南,而是分段研究。 買家希望立即瀏覽各個部分以獲取所需的信息。

因此,您的說明手冊應該允許客戶使用有組織的層次結構輕鬆瀏覽它。 製作用戶指南內容的基本結構,以及主要部分和副標題。

增強視覺效果

將視覺效果(例如圖像和視頻)添加到您的內容中,而不是僅用文本填充。 這將引起用戶的注意並增加參與度。

根據 TechSmith 的一項研究,大多數人 (83%) 更喜歡觀看視頻,而不是閱讀操作指南或知識庫材料。

老實說,用戶指南並不總是有趣的。 它們可能包含許多不會引起讀者註意的書面內容。

另一方面,使用視頻剪輯和照片比僅依靠書面材料更能有效地傳達信息。

例如,這份宜家用戶指南在沒有任何書面說明的情況下演示了組裝椅子的精確步驟。 客戶可以僅使用視覺提示來執行這些步驟。

宜家僅包含圖像的用戶手冊示例

如果您不包含圖形,您的說明手冊將變得充滿文字牆,沒有任何元素來分隔它或吸引客戶。

在您的數字用戶指南中加入視頻和圖像是增加用戶互動和幫助用戶成功的絕佳方法。

測試您的使用說明書

與新用戶或員工一起測試您的用戶手冊,並徵求對用戶指南的反饋,以便對其進行修改以獲得最佳用戶體驗。

創建用戶指南後,重要的是要嘗試它對之前沒有使用過您的產品的客戶是否有效。

為此,請嘗試與新客戶一起評估用戶指南,看看他們如何使用產品指南。

寫下您的說明手冊中讀者遇到困難的區域,並根據他們的反饋進行更改。 您的用戶指南應該能讓讀者在沒有額外幫助的情況下使用它。

發布您的使用說明書

使用 Heroic KB 等知識庫工具來創建、處理和跟踪說明手冊的性能。 它允許您與多個用戶協作並嵌入引人注目的視覺輔助工具,使您的手冊引人入勝。

如果沒有發布和共享平台,編寫出色的說明手冊是沒有用的。 這就是 Heroic KB 的用武之地。它是用於製作用戶指南和其他在線辦公材料的終極文檔軟件。

Heroic KB 允許您創建、處理和監控信息,例如用戶指南、程序手冊和技術文章。

它不僅可以讓許多人作為一個團隊在用戶指南上工作,而且還可以幫助他們添加任何類型的引人注目的視覺輔助工具,例如 YouTube 剪輯,或附加電子表格或文檔。

使其易於搜索和導航

使用內容豐富的標題、添加搜索欄並包含目錄,使您的手冊易於瀏覽。 您可以使用 Heroic KB 添加強大的搜索欄和自動目錄。

根據 Wyzowl 的最新研究,80% 的客戶如果不了解如何操作應用程序或程序,就會卸載它們。 此外,55% 的買家會出於同樣的原因退回產品或要求退款。

如果您的用戶找不到他們需要的信息,他們很快就會對您的產品感到厭煩。 因此,您可以採取以下一些步驟來使您的說明手冊易於搜索和瀏覽:

使用描述性標題而不是標準標題——詳細的標題為用戶提供了一個部分的主要概念,使他們能夠發現他們需要的信息。

提供搜索框——為確保用戶可以輕鬆查找所需資料,您最好為其提供易於訪問的搜索框。 它還應該能夠根據訪問者輸入的單詞猜測正確的文章,並查看標題和手冊的文本。

包括目錄——如果您的用戶手冊很長或內容很多,那麼添加目錄的重要性就會大大增加。 它允許用戶迅速找到並到達特定部分。

有許多解決方案可用於實現所有這些步驟而無需修改代碼。 例如,Heroic KB 使用用戶指南的標題創建一個自動目錄。

Heroic KB 的搜索欄快速找到答案

不僅如此。 其強大的搜索功能使您能夠毫不費力地尋找問題的解決方案。 當用戶輸入查詢時,搜索欄會快速顯示匹配的文章。

確保有吸引力的設計

通過自定義結構、排版、顏色和品牌元素等各個方面來改善說明手冊的外觀和感覺。

除了視覺效果的放置,您還應該考慮文檔的外觀和感覺。

例如,結構類型、材料順序、文本大小、字體系列、顏色和標題決定了手冊的整體外觀。 這些組件應該使它在視覺上對讀者有吸引力。

例如,看看這個 Elvie 用戶指南,它包含優雅的字體、舒緩的色彩和現代圖形,因此很有吸引力。

設計精美的 Elvie 用戶指南

例如,Heroic KB 可讓您製作一開始就令人驚嘆的說明指南。 它的信息中心提供高級外觀和感覺,使您的手冊外觀精美。

使用 Heroic KB 創建的默認用戶手冊示例

如果你想讓你的手冊與你公司的品牌個性保持一致,Heroic KB 中有多種設置可以讓你做到這一點。

監控性能

跟踪參與度指標,例如觀眾在手冊上花費的時間、他們被訪問的頻率以及是否有人閱讀。 並使用這些信息來改進您的指南。

想一想:如果您可以監控用戶在說明手冊上停留的時間、閱讀次數以及是否只看過一次,會怎麼樣?

這將使您能夠確定客戶是否真的查看了所提供的支持內容。

例如,Heroic KB 的分析功能可讓您監控導遊的參與度,並提供可用於改進手冊的令人難以置信的數據。

Heroic KB 的分析儀表板可跟踪您的說明手冊的有效性

更新您的手冊

通過考慮讀者的建議並採取行動,您可以確保您的手冊真正幫助他們實現目標和解決問題。

除了從指導手冊的參與數據中獲得見解外,從客戶那裡獲得直接反饋也很重要。

例如,當您使用 WordPress 和 Heroic KB 創建和發布手冊時,您可以收集訪問者的反饋。

Heroic KB 的反饋界面,幫助您完善用戶手冊

用戶可以對手冊投贊成票和反對票,並說明他們這樣做的原因。 這可以讓您有效地改進您的用戶手冊。

有關使用說明書的常見問題

以下是與用戶手冊相關的一些常見問題的答案。

說明書有什麼用?

說明手冊用於提供有關如何使用、操作或組裝產品或系統的詳細指導。 它們通常由製造商提供,是用戶了解如何有效、安全地使用產品的重要工具。 因此,用戶可以從他們的購買中獲得最大收益。

使用說明書中應包含哪些信息?

說明手冊通常包括分步說明、圖表和插圖,以解釋如何組裝、操作或維護產品。 它們還可能包括安全預防措施、故障排除提示和保修信息。

使用說明書有哪些格式?

說明手冊可以有多種格式,具體取決於產品類型和目標受眾。 以下是一些常見的格式:

  • 印刷手冊:這些是產品隨附的物理文檔,通常採用小冊子的形式。
  • PDF 手冊:這些是印刷手冊的數字版本,可以從製造商的網站下載。
  • 在線手冊:這些是託管在製造商網站上的手冊,可以通過網絡瀏覽器訪問。
  • 移動應用程序:一些產品附帶一個配套應用程序,其中包括說明手冊、教程和其他有用的資源。

總結:開始使用說明手冊

如您所見,說明手冊是客戶支持不可或缺的一部分。 它在讓用戶了解您的產品或服務方面發揮著重要作用。

雖然創建說明手冊可能需要一些時間和精力,但結果是值得的。 並且您應該定期更新手冊。

這就是 WordPress 和 Heroic KB 的組合真正可以幫助您加快速度的地方。 使用 Heroic KB,您不僅可以開箱即用地創建精美而專業的用戶指南,還可以收集用戶反饋和參與數據來改進它們。

總體而言,提供相關且有用的說明手冊將使客戶滿意,他們會長期堅持使用您的品牌。