如何寫內嵌式的幫助文檔
Baklib
關注
2022-04-02 18:25
551次閱讀
尼爾森十大交互原則的最后一個原則——“人性化幫助原則”提出，我們應該給系統提供一份幫助手冊。因為用戶在使用產品的過程中，經常會遇見問題，需要查看幫助文檔和說明書，這樣也能讓用戶能夠盡快了解系統，熟悉操作。
首先我們先來聊聊為什么要制作幫助手冊，這樣才能了解它的價值，從而為其付出更多努力。
- 幫助用戶更好地解決問題
- 引導用戶在答案中行為
- 減輕客戶服務壓力，培訓新客戶服務
- 樹立良好的品牌形象
- 有助于產品網絡營銷
- 有助于優化網站SEO
事實上，大約有兩種類型的幫助手冊。
一是網站上的幫助中心。幫助中心的問題是一些常見的問題，如該軟件適用于哪種規模的公司、產品定價和版本選擇。二是嵌入系統中的幫助文檔，專注于向用戶展示業務操作步驟，用戶可以邊看邊操作。今天我們要講的就是如何寫內嵌的幫助文檔。
軟件中嵌入的幫助文檔似乎很簡單，但實際上有很多細節。一些軟件幫助文檔的布局和排版非常隨意，所有內容都是文本或圖片。乍一看，它們很密集，找不到關鍵點。那么，如何寫嵌入式幫助文檔呢？
1.流程清晰
在撰寫幫助文檔時，產品首先應該非常熟悉每個過程中的過程和狀態的變化。例如，手動賬戶，管家賬戶，所以產品經理應該首先找出什么時候手動賬戶記錄，什么操作會改變賬單狀態等。
如果產品本身不清楚，它自然會在幫助文檔中寫得非常混亂。此外，如果一個過程涉及多個終端，那么它也應該清楚地寫下每個終端的操作會導致什么狀態，即記錄整個過程。例如，移動終端的操作會導致網絡終端的變化，這也應該寫清楚。
2.文字要少
幫助文檔，文字不能太多，主要是描述步驟。然后協助截圖，用箭頭指示操作按鈕。
如果文檔太多，會影響用戶的閱讀體驗，讓用戶不耐煩地閱讀。
3.展示重要問題
當我開始寫產品文檔時，我很容易把產品文檔寫成每個模塊的描述文檔。因為有些模塊是顯示模塊，不涉及過程，也沒有復雜的功能，所以這些模塊是圖片和干燥的幾句話。這導致了很長一段時間，沒有重點，可讀性也不高。所以在寫作時，要考慮用戶最關心的問題，以及模塊中復雜的業務流程。
房子的查看，賬單的查看，這些簡單的問題，完全不需要介紹，用戶自然會知道。對于那些進入住房、手動賬戶、現金提取和貸款這些稍深的業務問題是用戶想要看到的。因此，在撰寫產品之前，您可以完善您負責的模塊的一些重要過程和主要操作。然后在此基礎上，考慮如何用最少的文本進行最全面的解釋。
4.統一模板
尼爾森的互動原則之一是一致性原則。這也適用于幫助文檔。由于不同的產品通常負責不同的模塊，如果模板在開始時不統一，最終的效果很容易混亂。
最好使用統一的模板來幫助文檔，然后在頁面上顯示公司名稱和標志。
事實上，有很多款式，包括word、ppt和pdf文檔。現在，風格更好的是使用ppt，然后轉換為pdf格式。這樣，無論是頁面顯示還是在線觀看，體驗都會更好。
5.常見問題說明
嵌入式幫助文檔還需要解釋常見問題，特別是一些常見的異常情況，更需要提醒。例如，一些隱藏的限制將在拒絕結算和貸款后的第二天自動啟動貸款申請。因為這些都是通過定期任務進行的，所以很難在頁面上告訴用戶。因此，您可以在幫助文檔中回答用戶的這些問題。
這里選擇使用Baklib撰寫幫助文檔。
baklib是一款中國的在線的文本編輯和托管的工具，對于企業用戶不僅可以制作FAQ幫助文檔，還可以編寫知識庫、產品手冊、幫助中心、發行說明。對于愛好寫作的用戶來說，可以編寫日記手帳和個人博客，功能超級贊！獨立域名，多種模板支持將創作的內容按模板導成各種漂亮的界面，使內容分享更方便，更有利于個人品牌口碑的形成。
產品評價：
- 易于編輯，結構清晰。
- 豐富的展示模板，排版界面友好。
- 文本檢索功能強。
- 高自由度的展示設置。
- 獨立域名。
- 多端適配，無需下載。
- 也可以用于FAQ、知識庫、發行說明和個人博客等。
制作步驟：
首先需要訪問Baklib官網，百度搜索Baklib就能找到，注冊帳號登錄，點擊創建站點（幫助文檔）
選擇創建的場景，這里選擇幫助文檔制作
選擇適合的頁面主題模板，官網提供了十多個免費的主題模板，后面可以根據需要在設置進行更換
最后填寫名稱，二級域名（免費），選擇和你產品契合的主題顏色
最后一步就進入到了內容編輯界面，編輯好你的幫助手冊的內容就完成了。
以上就是今天的全部內容，希望對你有幫助。下一次我們會講到另外一種幫助手冊的制作——幫助中心。
Baklib
+
關注
0
