寫過數(shù)萬字的操作手冊聊聊用戶使用說明書該怎么寫

寫過數(shù)萬字的操作手冊，聊聊用戶使用說明書該怎么寫？用戶使用說明書，是為了能夠讓用戶能更清晰地使用產(chǎn)品而編寫的。作者提到了一個編寫的小技巧，就是把它當(dāng)成一個需求來處理，那么具體要如何編寫，注意哪些細節(jié)？作者從明確需求的目的到最后的調(diào)整和完善都做出了詳細的講解，歡迎閱讀。01前言最近主導(dǎo)了幾個項目操作手冊的編寫。有新開發(fā)的項目，要重新編寫操作手冊；有中途接手別的項目，后來功能迭代，需要更新原操作手冊；有客戶對操作手冊有意見，需要調(diào)整；零零散散寫了數(shù)萬字的手冊。其實寫操作手冊或者叫用戶使用說明書可以當(dāng)作一個需求來處理。既然是需求，那么處理需求的幾個主要步驟對于產(chǎn)品經(jīng)理來說就是輕車熟路了。明確需求的目的明確目標用戶明確使用場景形成解決方案最小代價驗證方案調(diào)整并完善方案（編寫文檔到這一步就可以結(jié)束了）02明確編寫目的、目標用戶、使用場景編寫目的：操作手冊就是介紹系統(tǒng)如何操作。對于交付型的項目，在交付的時候需要有這個文檔。對于toB的項目，一般也會為客戶提供該文檔。即便目前有多種為用戶介紹系統(tǒng)如何使用的方式，但是這個手冊作為一個全面、詳細的文檔，在一些場景下還是有必要的。目標用戶：客服人員、系統(tǒng)用戶（注意可能會有多個角色，比如管理員、操作員、被管理人員等）。使用場景：客服人員多是軟件的開發(fā)方的人員，當(dāng)系統(tǒng)大到一定程度后，一些詳細的規(guī)則單靠記憶很難覆蓋，在遺忘的時候可以拿操作手冊作為參考。一個是軟件的實際使用人員，在遇到問題又找不到客服時，可通過操作手冊進行快速查找。綜合來看主要是兩個場景：從頭開始認識一個功能。查找某個功能的某一步的詳細規(guī)則。03形成解決方案針對編寫目的、用戶、場景，總結(jié)出操作手冊必備的幾個要素。明確的目錄結(jié)構(gòu)，既能讓用戶對系統(tǒng)有個整體全面的認識，又能方便用戶查找功能概述，根據(jù)目錄的劃分，對功能進行簡要介紹，說明這個功能是干什么的詳細操作步驟，介紹每一步該怎么做，有什么注意事項1.目錄結(jié)構(gòu)一般操作手冊會根據(jù)不同的人有不同的版本，但是如果為每個人單獨寫一份，這個工作量就太大了。最好在寫的時候就按使用人來劃分，這樣就可以只寫管理員（擁有系統(tǒng)全部權(quán)限）版本，然后將管理員版本中的部分摘出來即可形成多個版本。比如一個系統(tǒng)有移動端和PC端，如果PC端作為管理、配置功能，給操作員用。PC端是展示，給管理者用，那么目錄可以分移動端和PC端，然后再分更細的功能；如果同一個用戶既可以在移動端完成該功能，又可以在PC端完成，那么目錄可以按照功能進行劃分。按照這樣的邏輯劃分就可以達到上述目的。如果系統(tǒng)目錄劃分比較清晰，詳細的功能可以按照目錄來劃分。這里toB系統(tǒng)的產(chǎn)品經(jīng)理應(yīng)該很熟悉。如果不清晰，建議先優(yōu)化系統(tǒng)目錄?；蛘呦到y(tǒng)功能本身很瑣碎，操作手冊可以按照事項來劃分。比如某項信息要在前端展示，需要經(jīng)歷信息的上傳、審核、發(fā)布等流程。那么既可以分開介紹某各流程具體怎么操作，也可以將信息怎么發(fā)布作為一個模塊來整體介紹，或者寫一個整體的流程框架，具體某步驟參照某章節(jié)。具體寫法需根據(jù)系統(tǒng)的實際情況來判斷。2.功能概述功能概述的目的是讓手冊使用者（很可能對系統(tǒng)完全不了解）對某個功能有一個整體的認識，知道為什么又這個功能，這個功能是干什么的，通過哪些步驟可以完成相關(guān)功能。可以讓其它業(yè)務(wù)線的小伙伴來看你的描述，如果一看就懂，說明寫的不錯。沒看懂的話可以與其進行溝通，看疑問的點在哪里，有針對性的調(diào)整描述?？梢匀绻鞒梯^為復(fù)雜，可以用流程圖等來輔助說明。3.詳細操作步驟每一步具體怎么操作，點擊哪個按鈕，填寫哪些字段。各個按鈕點擊有什么效果，字段填寫有什么意義會影響到哪里。這些內(nèi)容該怎么寫，主要是根據(jù)頁面和功能的種類。比如列表頁，如果都是些根據(jù)名稱能知道含義的字段，那么就不需要介紹。如果有些容易混淆的詞，比如“更新時間”是只有用戶在當(dāng)前頁面對數(shù)據(jù)修改進行記錄，還是在其它頁面做修改，導(dǎo)致該頁面的數(shù)據(jù)產(chǎn)生變化時也做記錄。這時候需要說明，否則用戶在使用過程中會進行大量的提問。如果系統(tǒng)有專有名詞，也需要進行描述。（最好單獨用一小節(jié)對其進行統(tǒng)一介紹）圖片是操作手冊的重要部分。但不能把系統(tǒng)上的圖直接放在操作手冊中。有幾個需要注意的點：圈出每個步驟需要點擊的按鈕的位置標明第一步點擊哪里第二步點擊哪里做到這兩點已經(jīng)很清晰了。在大量的實踐中，我發(fā)現(xiàn)最好把同一個功能里的幾個步驟做一個長圖，這樣在文檔中查看時不會形成大量的空白部分，能夠更快的看出每個步驟是什么。如果客戶沒有看操作手冊，直接問，客服可以把長圖給他。04驗證并完善方案1.小范圍發(fā)布寫好后，可以讓公司其它小伙伴看一下，最好是目標用戶。比如你手冊的目標用戶是運維，可以找其它產(chǎn)品線的運維伙伴來看。比如你的目標用戶是客戶，可以先小范圍發(fā)給典型客戶或關(guān)系較好的客戶，收集問題，對操作手冊進行調(diào)整。這個類似于產(chǎn)品的初步驗證，用草圖、原型各種能讓用戶理解體會到產(chǎn)品流程的方式，對產(chǎn)品進行初步的體驗并提出意見。2.根據(jù)反饋進行調(diào)整目標用戶對操作手冊的反饋主要有兩個方面。一個是用戶的直接反饋，一個是用戶的使用方式。用戶閱讀手冊后，可以與用戶溝通使用意見，看哪里不容易理解，哪里查看起來不方便，以此來調(diào)整手冊的結(jié)構(gòu)及表達方式。另外可以觀察用戶如何查閱手冊，看針對幾個特殊場景（初次使用時的整體閱讀及查詢某個細節(jié)時尋找解決方法）的使用情況，來發(fā)掘文檔可能存在的優(yōu)化點。這個相當(dāng)于既要通過訪談的方式溝通用戶對產(chǎn)品的意見，又要通過觀察的方式找出用戶在使用中遇到的問題。05幾點經(jīng)驗1.版本管理首先有一個操作手冊基線版本，在第一次寫完后記錄當(dāng)前操作手冊對應(yīng)的系統(tǒng)版本。然后根據(jù)系統(tǒng)的升級情況，會逐步往操作手冊中增加內(nèi)容，此時需記錄每次都增加了哪些內(nèi)容，對應(yīng)了系統(tǒng)的哪些版本。因為系統(tǒng)更新后不一定每次都有時間立即更新操作手冊，而且當(dāng)操作手冊的規(guī)模大到一定程度，再去核對手冊跟系統(tǒng)的區(qū)別，將耗費大量的時間且操作起來極其繁瑣?？稍谑謨灾性黾右粋€小節(jié)對此進行專門記錄，寫明手冊版本、更改人、更改時間、更改內(nèi)容。如有必要可增加審核人及審核時間。2.明確/申明概念將系統(tǒng)中特有名詞進行解釋。這些內(nèi)容在系統(tǒng)設(shè)計之初應(yīng)該有相關(guān)描述，可根據(jù)需要進行摘錄。明確了概念才能順暢溝通，而且很多問題本身也是不知道概念才產(chǎn)生的。3.格式統(tǒng)一主要是為了方便閱讀。查看起來文檔美觀，查找相關(guān)內(nèi)容也比較方便。寫之前先定好規(guī)范，審核文檔時作為審核項。修改文檔前先看一下其它章節(jié)，不至于每次增加內(nèi)容有用新的格式。文檔格式主要有下面兩種。文檔格式。文檔標題、正文、表頭等內(nèi)容格式統(tǒng)一。表達格式。比如描述按鈕時統(tǒng)一用【】，描述系統(tǒng)提示時統(tǒng)一用“”等等，這個在手冊內(nèi)統(tǒng)一即可。4.其它形式的操作手冊頁面內(nèi)的提示文字對于容易產(chǎn)生疑問的地方，用簡短的提示文字解釋?？梢灾苯訉懺陧撁嫔?，也可以增加小圖標，點擊后查看提示；根據(jù)提示的重要程度進行設(shè)計。文字一定要簡短易懂。常見問題解答這個模塊可在操作手冊中增加，也可以在系統(tǒng)中提供相關(guān)頁面。系統(tǒng)中提供頁面的優(yōu)勢在于隨時可查看