如何寫內(nèi)嵌式的幫助文檔

Baklib

+ 關(guān)注

2022-04-02 18:25

519次閱讀

尼爾森十大交互原則的最后一個(gè)原則——“人性化幫助原則”提出，我們應(yīng)該給系統(tǒng)提供一份幫助手冊(cè)。因?yàn)橛脩粼谑褂卯a(chǎn)品的過程中，經(jīng)常會(huì)遇見問題，需要查看幫助文檔和說明書，這樣也能讓用戶能夠盡快了解系統(tǒng)，熟悉操作。

首先我們先來聊聊為什么要制作幫助手冊(cè)，這樣才能了解它的價(jià)值，從而為其付出更多努力。

幫助用戶更好地解決問題
引導(dǎo)用戶在答案中行為
減輕客戶服務(wù)壓力，培訓(xùn)新客戶服務(wù)
樹立良好的品牌形象
有助于產(chǎn)品網(wǎng)絡(luò)營(yíng)銷
有助于優(yōu)化網(wǎng)站SEO

事實(shí)上，大約有兩種類型的幫助手冊(cè)。

一是網(wǎng)站上的幫助中心。幫助中心的問題是一些常見的問題，如該軟件適用于哪種規(guī)模的公司、產(chǎn)品定價(jià)和版本選擇。二是嵌入系統(tǒng)中的幫助文檔，專注于向用戶展示業(yè)務(wù)操作步驟，用戶可以邊看邊操作。今天我們要講的就是如何寫內(nèi)嵌的幫助文檔。

軟件中嵌入的幫助文檔似乎很簡(jiǎn)單，但實(shí)際上有很多細(xì)節(jié)。一些軟件幫助文檔的布局和排版非常隨意，所有內(nèi)容都是文本或圖片。乍一看，它們很密集，找不到關(guān)鍵點(diǎn)。那么，如何寫嵌入式幫助文檔呢？

在撰寫幫助文檔時(shí)，產(chǎn)品首先應(yīng)該非常熟悉每個(gè)過程中的過程和狀態(tài)的變化。例如，手動(dòng)賬戶，管家賬戶，所以產(chǎn)品經(jīng)理應(yīng)該首先找出什么時(shí)候手動(dòng)賬戶記錄，什么操作會(huì)改變賬單狀態(tài)等。

如果產(chǎn)品本身不清楚，它自然會(huì)在幫助文檔中寫得非常混亂。此外，如果一個(gè)過程涉及多個(gè)終端，那么它也應(yīng)該清楚地寫下每個(gè)終端的操作會(huì)導(dǎo)致什么狀態(tài)，即記錄整個(gè)過程。例如，移動(dòng)終端的操作會(huì)導(dǎo)致網(wǎng)絡(luò)終端的變化，這也應(yīng)該寫清楚。

幫助文檔，文字不能太多，主要是描述步驟。然后協(xié)助截圖，用箭頭指示操作按鈕。

如果文檔太多，會(huì)影響用戶的閱讀體驗(yàn)，讓用戶不耐煩地閱讀。

當(dāng)我開始寫產(chǎn)品文檔時(shí)，我很容易把產(chǎn)品文檔寫成每個(gè)模塊的描述文檔。因?yàn)橛行┠K是顯示模塊，不涉及過程，也沒有復(fù)雜的功能，所以這些模塊是圖片和干燥的幾句話。這導(dǎo)致了很長(zhǎng)一段時(shí)間，沒有重點(diǎn)，可讀性也不高。所以在寫作時(shí)，要考慮用戶最關(guān)心的問題，以及模塊中復(fù)雜的業(yè)務(wù)流程。

房子的查看，賬單的查看，這些簡(jiǎn)單的問題，完全不需要介紹，用戶自然會(huì)知道。對(duì)于那些進(jìn)入住房、手動(dòng)賬戶、現(xiàn)金提取和貸款這些稍深的業(yè)務(wù)問題是用戶想要看到的。因此，在撰寫產(chǎn)品之前，您可以完善您負(fù)責(zé)的模塊的一些重要過程和主要操作。然后在此基礎(chǔ)上，考慮如何用最少的文本進(jìn)行最全面的解釋。

尼爾森的互動(dòng)原則之一是一致性原則。這也適用于幫助文檔。由于不同的產(chǎn)品通常負(fù)責(zé)不同的模塊，如果模板在開始時(shí)不統(tǒng)一，最終的效果很容易混亂。

最好使用統(tǒng)一的模板來幫助文檔，然后在頁(yè)面上顯示公司名稱和標(biāo)志。

事實(shí)上，有很多款式，包括word、ppt和pdf文檔。現(xiàn)在，風(fēng)格更好的是使用ppt，然后轉(zhuǎn)換為pdf格式。這樣，無論是頁(yè)面顯示還是在線觀看，體驗(yàn)都會(huì)更好。

嵌入式幫助文檔還需要解釋常見問題，特別是一些常見的異常情況，更需要提醒。例如，一些隱藏的限制將在拒絕結(jié)算和貸款后的第二天自動(dòng)啟動(dòng)貸款申請(qǐng)。因?yàn)檫@些都是通過定期任務(wù)進(jìn)行的，所以很難在頁(yè)面上告訴用戶。因此，您可以在幫助文檔中回答用戶的這些問題。

這里選擇使用Baklib撰寫幫助文檔。

baklib是一款中國(guó)的在線的文本編輯和托管的工具，對(duì)于企業(yè)用戶不僅可以制作FAQ幫助文檔，還可以編寫知識(shí)庫(kù)、產(chǎn)品手冊(cè)、幫助中心、發(fā)行說明。對(duì)于愛好寫作的用戶來說，可以編寫日記手帳和個(gè)人博客，功能超級(jí)贊！獨(dú)立域名，多種模板支持將創(chuàng)作的內(nèi)容按模板導(dǎo)成各種漂亮的界面，使內(nèi)容分享更方便，更有利于個(gè)人品牌口碑的形成。