寫過(guò)數(shù)萬(wàn)字的操作手冊(cè)聊聊用戶使用說(shuō)明書(shū)該怎么寫

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