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

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

最近主導(dǎo)了幾個(gè)項(xiàng)目操作手冊的編寫。有新開發(fā)的項(xiàng)目，要重新編寫操作手冊；有中途接手別的項(xiàng)目，后來功能迭代，需要更新原操作手冊；有客戶對操作手冊有看法，需要調(diào)整；零零散散寫了數(shù)萬字的手冊。

其實(shí)寫操作手冊或者叫用戶使用說明書可以當(dāng)作一個(gè)需求來處理。既然是需求，那么處理需求的幾個(gè)主要步驟對于產(chǎn)品經(jīng)理來說就是輕車熟路了。

明確需求的目的明確目標(biāo)用戶明確使用場景形成解決方案最小代價(jià)驗(yàn)證方案調(diào)整并完善方案（編寫文檔到這一步就可以結(jié)束了）02明確編寫目的、目標(biāo)用戶、使用場景

編寫目的：操作手冊就是介紹系統(tǒng)如何操作。對于交付型的項(xiàng)目，在交付的時(shí)候需要有這個(gè)文檔。對于toB的項(xiàng)目，一般也會為客戶供應(yīng)該文檔。即便目前有多種為用戶介紹系統(tǒng)如何使用的方式，但是這個(gè)手冊作為一個(gè)全面、具體的文檔，在一些場景下還是有必要的。

目標(biāo)用戶：客服人員、系統(tǒng)用戶（留意可能會有多個(gè)角色，比如管理員、操作員、被管理人員等）。

使用場景：客服人員多是軟件的開發(fā)方的人員，當(dāng)系統(tǒng)大到肯定程度后，一些具體的規(guī)章單靠記憶很難掩蓋，在遺忘的時(shí)候可以拿操作手冊作為參考。一個(gè)是軟件的實(shí)際使用人員，在遇到問題又找不到客服時(shí)，可通過操作手冊進(jìn)行快速查找。綜合來看主要是兩個(gè)場景：

從頭開頭熟悉一個(gè)功能。查找某個(gè)功能的某一步的具體規(guī)章。03形成解決方案

針對編寫目的、用戶、場景，總結(jié)出操作手冊必備的幾個(gè)要素。

明確的名目結(jié)構(gòu)，既能讓用戶對系統(tǒng)有個(gè)整體全面的熟悉，又能便利用戶查找功能概述，依據(jù)名目的劃分，對功能進(jìn)行簡要介紹，說明這個(gè)功能是干什么的具體操作步驟，介紹每一步該怎么做，有什么留意事項(xiàng)1.名目結(jié)構(gòu)

一般操作手冊會依據(jù)不同的人有不同的版本，但是假如為每個(gè)人單獨(dú)寫一份，這個(gè)工作量就太大了。最好在寫的時(shí)候就按使用人來劃分，這樣就可以只寫管理員（擁有系統(tǒng)全部權(quán)限）版本，然后將管理員版本中的部分摘出來即可形成多個(gè)版本。

比如一個(gè)系統(tǒng)有移動(dòng)端和PC端，假如PC端作為管理、配置功能，給操作員用。PC端是展現(xiàn)，給管理者用，那么名目可以分移動(dòng)端和PC端，然后再分更細(xì)的功能；假如同一個(gè)用戶既可以在移動(dòng)端完成該功能，又可以在PC端完成，那么名目可以根據(jù)功能進(jìn)行劃分。根據(jù)這樣的規(guī)律劃分就可以達(dá)到上述目的。

假如系統(tǒng)名目劃分比較清楚，具體的功能可以根據(jù)名目來劃分。這里toB系統(tǒng)的產(chǎn)品經(jīng)理應(yīng)當(dāng)很熟識。假如不清楚，建議先優(yōu)化系統(tǒng)名目?；蛘呦到y(tǒng)功能本身很瑣碎，操作手冊可以根據(jù)事項(xiàng)來劃分。

比如某項(xiàng)信息要在前端展現(xiàn)，需要經(jīng)受信息的上傳、審核、發(fā)布等流程。那么既可以分開介紹某各流程詳細(xì)怎么操作，也可以將信息怎么發(fā)布作為一個(gè)模塊來整體介紹，或者寫一個(gè)整體的流程框架，詳細(xì)某步驟參照某章節(jié)。詳細(xì)寫法需依據(jù)系統(tǒng)的實(shí)際狀況來推斷。

2.功能概述

功能概述的目的是讓手冊使用者（很可能對系統(tǒng)完全不了解）對某個(gè)功能有一個(gè)整體的熟悉，知道為什么又這個(gè)功能，這個(gè)功能是干什么的，通過哪些步驟可以完成相關(guān)功能?？梢宰屍渌鼧I(yè)務(wù)線的小伙伴來看你的描述，假如一看就懂，說明寫的不錯(cuò)。沒看懂的話可以與其進(jìn)行溝通，看疑問的點(diǎn)在哪里，有針對性的調(diào)整描述。

可以假如流程較為簡單，可以用流程圖等來幫助說明。

3.具體操作步驟

每一步詳細(xì)怎么操作，點(diǎn)擊哪個(gè)按鈕，填寫哪些字段。各個(gè)按鈕點(diǎn)擊有什么效果，字段填寫有什么意義會影響到哪里。這些內(nèi)容該怎么寫，主要是依據(jù)頁面和功能的種類。

比如列表頁，假如都是些依據(jù)名稱能知道含義的字段，那么就不需要介紹。假如有些簡單混淆的詞，比如“更新時(shí)間”是只有用戶在當(dāng)前頁面對數(shù)據(jù)修改進(jìn)行記錄，還是在其它頁面做修改，導(dǎo)致該頁面的數(shù)據(jù)產(chǎn)生變化時(shí)也做記錄。

這時(shí)候需要說明，否則用戶在使用過程中會進(jìn)行大量的提問。假如系統(tǒng)有專出名詞，也需要進(jìn)行描述。（最好單獨(dú)用一小節(jié)對其進(jìn)行統(tǒng)一介紹）

圖片是操作手冊的重要部分。但不能把系統(tǒng)上的圖直接放在操作手冊中。有幾個(gè)需要留意的點(diǎn)：

圈出每個(gè)步驟需要點(diǎn)擊的按鈕的位置標(biāo)明第一步點(diǎn)擊哪里其次步點(diǎn)擊哪里做到這兩點(diǎn)已經(jīng)很清楚了。在大量的實(shí)踐中，我發(fā)覺最好把同一個(gè)功能里的幾個(gè)步驟做一個(gè)長圖，這樣在文檔中查看時(shí)不會形成大量的空白部分，能夠更快的看出每個(gè)步驟是什么。假如客戶沒有看操作手冊，直接問，客服可以把長圖給他。

04驗(yàn)證并完善方案

1.小范圍發(fā)布

寫好后，可以讓公司其它小伙伴看一下，最好是目標(biāo)用戶。比如你手冊的目標(biāo)用戶是運(yùn)維，可以找其它產(chǎn)品線的運(yùn)維伙伴來看。比如你的目標(biāo)用戶是客戶，可以先小范圍發(fā)給典型客戶或關(guān)系較好的客戶，收集問題，對操作手冊進(jìn)行調(diào)整。這個(gè)類似于產(chǎn)品的初步驗(yàn)證，用草圖、原型各種能讓用戶理解體會到產(chǎn)品流程的方式，對產(chǎn)品進(jìn)行初步的體驗(yàn)并提出看法。

2.依據(jù)反饋進(jìn)行調(diào)整

目標(biāo)用戶對操作手冊的反饋主要有兩個(gè)方面。一個(gè)是用戶的直接反饋，一個(gè)是用戶的使用方式。

用戶閱讀手冊后，可以與用戶溝通使用看法，看哪里不簡單理解，哪里查看起來不便利，以此來調(diào)整手冊的結(jié)構(gòu)及表達(dá)方式。另外可以觀看用戶如何查閱手冊，看針對幾個(gè)特別場景（初次使用時(shí)的整體閱讀及查詢某個(gè)細(xì)節(jié)時(shí)查找解決方法）的使用狀況，來發(fā)掘文檔可能存在的優(yōu)化點(diǎn)。這個(gè)相當(dāng)于既要通過訪談的方式溝通用戶對產(chǎn)品的看法，又要通過觀看的方式找出用戶在使用中遇到的問題。

05幾點(diǎn)閱歷

1.版本管理

首先有一個(gè)操作手冊基線版本，在第一次寫完后記錄當(dāng)前操作手冊對應(yīng)的系統(tǒng)版本。然后依據(jù)系統(tǒng)的升級狀況，會逐步往操作手冊中增加內(nèi)容，此時(shí)需記錄每次都增加了哪些內(nèi)容，對應(yīng)了系統(tǒng)的哪些版本。

由于系統(tǒng)更新后不肯定每次都有時(shí)間馬上更新操作手冊，而且當(dāng)操作手冊的規(guī)模大到肯定程度，再去核對手冊跟系統(tǒng)的區(qū)分，將耗費(fèi)大量的時(shí)間且操作起來極其繁瑣。

可在手冊中增加一個(gè)小節(jié)對此進(jìn)行特地記錄，寫明手冊版本、更改人、更改時(shí)間、更改內(nèi)容。如有必要可增加審核人及審核時(shí)間。

2.明確/申明概念

將系統(tǒng)中特出名詞進(jìn)行解釋。這些內(nèi)容在系統(tǒng)設(shè)計(jì)之初應(yīng)當(dāng)有相關(guān)描述，可依據(jù)需要進(jìn)行摘錄。明確了概念才能順暢溝通，而且許多問題本身也是不知道概念才產(chǎn)生的。

3.格式統(tǒng)一

主要是為了便利閱讀。查看起來文檔美觀，查找相關(guān)內(nèi)容也比較便利。寫之前先定好規(guī)范，審核文檔時(shí)作為審核項(xiàng)。修改文檔前先看一下其它章節(jié)，不至于每次增加內(nèi)容有用新的格式。文檔格式主要有下面兩種。

文檔格式。文檔標(biāo)題、正文、表頭等內(nèi)容格式統(tǒng)一。表達(dá)格式。比如描述按鈕時(shí)統(tǒng)一用【】，描述系統(tǒng)提示時(shí)統(tǒng)一用“”等等，這個(gè)在手冊內(nèi)統(tǒng)一即可。4.其它形式的操作手冊

頁面內(nèi)的提示文字對于簡單產(chǎn)生疑問的地方，用簡短的提示文字解釋?？梢灾苯訉懺陧撁嫔希部梢栽黾有D標(biāo)，點(diǎn)擊后查看提示；依據(jù)提示的重要程度進(jìn)行設(shè)計(jì)。文字肯定要簡短易懂。常見問題解答這個(gè)模塊可在操作手冊中增加，也可以在系統(tǒng)中供應(yīng)相關(guān)頁面。系統(tǒng)中供應(yīng)頁面的優(yōu)勢在于隨時(shí)可查看，而且