寫過數(shù)萬字的利用手冊，聊聊用戶使用分析書該怎樣寫？

用戶使用分析書，是為了可以讓用戶能更明晰地使用產(chǎn)物而編寫的。作者提到了一個(gè)編寫的小本事，就是把它當(dāng)成一個(gè)需求來處理，那么具體要怎樣編寫，注意哪些細(xì)節(jié)？作者從明白需求的目標(biāo)到最初的調(diào)停和完滿都做出了具體的解說，接待閱讀。

01 弁言

邇來主導(dǎo)了幾個(gè)項(xiàng)目利用手冊的編寫。有新開發(fā)的項(xiàng)目，要重新編寫利用手冊；有中途接辦別的項(xiàng)目，厥后功效迭代，必要更新原利用手冊；有客戶對利用手冊故意見，必要調(diào)停；零零散散寫了數(shù)萬字的手冊。

但是寫利用手冊大概叫用戶使用分析書可以當(dāng)作一個(gè)需求來處理。既然是需求，那么處理需求的幾個(gè)主要步調(diào)關(guān)于產(chǎn)物司理來說就是得心應(yīng)手了。

1. 明白需求的目標(biāo)
2. 明白目標(biāo)用戶
3. 明白使用場景
4. 構(gòu)成處理方案
5. 最小代價(jià)驗(yàn)證方案
6. 調(diào)停并完滿方案（編寫文檔到這一步就可以完畢了）

02 明白編寫目標(biāo)、目標(biāo)用戶、使用場景

編寫目標(biāo)：利用手冊就是先容體系怎樣利用。關(guān)于交付型的項(xiàng)目，在交付的時(shí)分必要有這個(gè)文檔。關(guān)于to B的項(xiàng)目，尋常也會(huì)為客戶提供該文檔。即使現(xiàn)在有多種為用戶先容體系怎樣使用的辦法，但是這個(gè)手冊作為一個(gè)全盤、具體的文檔，在一些場景下照舊有必要的。

目標(biāo)用戶：客服職員、體系用戶（注意約莫會(huì)有多個(gè)人物，好比辦理員、利用員、被辦理職員等）。

使用場景：客服職員多是軟件的開發(fā)方的職員，當(dāng)體系大到一定水平后，一些具體的端正單靠影象很難掩蓋，在忘記的時(shí)分可以拿利用手冊作為參考。一個(gè)是軟件的實(shí)踐使用職員，在碰到成績又找不到客服時(shí)，可經(jīng)過利用手冊舉行快速查找。綜合來看主要是兩個(gè)場景：

03 構(gòu)成處理方案

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

1. 明白的目次布局，既能讓用戶對體系有個(gè)全體全盤的熟悉，又能便利用戶查找
2. 功效概述，依據(jù)目次的區(qū)分，對功效舉行扼要先容，分析這個(gè)功效是干什么的
3. 具體利用步調(diào)，先容每一步該怎樣做，有什么注意事項(xiàng)

1. 目次布局

尋常利用手冊會(huì)依據(jù)不同的人有不同的版本，但是假如為每一局部單獨(dú)寫一份，這個(gè)事情量就太大了。最幸而寫的時(shí)分就按使用人來區(qū)分，如此就可以只寫辦理員（擁有體系全部權(quán)限）版本，然后將辦理員版本中的局部摘出來即可構(gòu)成多個(gè)版本。

好比一個(gè)體系有挪動(dòng)端和PC端，假如PC端作為辦理、設(shè)置功效，給利用員用。PC端是展現(xiàn)，給辦理者用，那么目次可以分挪動(dòng)端和PC端，然后再分更細(xì)的功效；假如同一個(gè)用戶既可以在挪動(dòng)端完成該功效，又可以在PC端完成，那么目次可以依照功效舉行區(qū)分。依照如此的邏輯區(qū)分就可以到達(dá)上述目標(biāo)。

假如體系目次區(qū)分比力明晰，具體的功效可以依照目次來區(qū)分。這里to B體系的產(chǎn)物司理應(yīng)該很熟習(xí)。假如不明晰，發(fā)起先優(yōu)化體系目次。大概體系功效本身很嚕蘇，利用手冊可以依照事項(xiàng)來區(qū)分。

好比某項(xiàng)信息要在前端展現(xiàn)，必要履歷信息的上傳、稽核、公布等流程。那么既可以分開先容某各流程具體怎樣利用，也可以將信息怎樣公布作為一個(gè)模塊來全體先容，大概寫一個(gè)全體的流程框架，具體某步調(diào)參照某章節(jié)。具體寫法需依據(jù)體系的實(shí)踐情況來推斷。

2. 功效概述

功效概述的目標(biāo)是讓手冊使用者（很約莫對體系完全不了解）對某個(gè)功效有一個(gè)全體的熟悉，曉得為什么又這個(gè)功效，這個(gè)功效是干什么的，經(jīng)過哪些步調(diào)可以完成干系功效。可以讓別的業(yè)務(wù)線的小伙伴來看你的形貌，假如一看就懂，分析寫的不錯(cuò)。沒看懂的話可以與其舉行相反，看疑問的點(diǎn)在何處，有針對性的調(diào)停形貌。

可以假如流程較為繁復(fù)，可以用流程圖等來幫助分析。

3. 具體利用步調(diào)

每一步具體怎樣利用，點(diǎn)擊哪個(gè)按鈕，填寫哪些字段。各個(gè)按鈕點(diǎn)擊有什么后果，字段填寫有什么意義會(huì)影響到何處。這些內(nèi)容該怎樣寫，主要是依據(jù)頁面和功效的品種。

好比列表頁，假如都是些依據(jù)稱呼能曉得涵義的字段，那么就不必要先容。假如有些容易殽雜的詞，好比“更新時(shí)間”是僅有效戶在如今頁面臨數(shù)據(jù)修正舉行紀(jì)錄，照舊在別的頁面做修正，招致該頁面的數(shù)據(jù)產(chǎn)生厘革時(shí)也做紀(jì)錄。

這時(shí)分必要分析，不然用戶在使用歷程中會(huì)舉行多量的發(fā)問。假如體系有專出名詞，也必要舉行形貌。（最好單獨(dú)用一末節(jié)對其舉行一致先容）

圖片是利用手冊的緊張局部。但不克不及把體系上的圖直接放在利用手冊中。有幾個(gè)必要注意的點(diǎn)：

1. 圈出每個(gè)步調(diào)必要點(diǎn)擊的按鈕的地點(diǎn)
2. 標(biāo)明第一步點(diǎn)擊何處第二步點(diǎn)擊何處

做到這兩點(diǎn)以前很明晰了。在多量的實(shí)踐中，我發(fā)覺最好把同一個(gè)功效里的幾個(gè)步調(diào)做一個(gè)長圖，如此在文檔中查察時(shí)不會(huì)構(gòu)成多量的空缺局部，可以更快的看出每個(gè)步調(diào)是什么。假如客戶沒有看利用手冊，直接問，客服可以把長圖給他。

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

1. 小范圍公布

寫好后，可以讓公司別的小伙伴看一下，最好是目標(biāo)用戶。好比你手冊的目標(biāo)用戶是運(yùn)維，可以找別的產(chǎn)物線的運(yùn)維伙伴來看。好比你的目標(biāo)用戶是客戶，可以先小范圍發(fā)給典范客戶或干系較好的客戶，搜集成績，對利用手冊舉行調(diào)停。這個(gè)相似于產(chǎn)物的開頭驗(yàn)證，用草圖、原型種種能讓用戶了解了解到產(chǎn)物流程的辦法，對產(chǎn)物舉行開頭的體驗(yàn)并提出意見。

2. 依據(jù)反應(yīng)舉行調(diào)停

目標(biāo)用戶對利用手冊的反應(yīng)主要有兩個(gè)方面。一個(gè)是用戶的直接反應(yīng)，一個(gè)是用戶的使用辦法。

用戶閱讀手冊后，可以與用戶相反使意圖見，看何處不容易了解，何處查察起來不便利，以此來調(diào)停手冊的布局及表達(dá)辦法。別的可以察看用戶怎樣查閱手冊，看針對幾個(gè)特別場景（初次使用時(shí)的全體閱讀及查詢某個(gè)細(xì)節(jié)時(shí)尋覓處理辦法）的使用情況，來發(fā)掘文檔約莫存在的優(yōu)化點(diǎn)。這個(gè)相當(dāng)于既要經(jīng)過訪談的辦法相反用戶對產(chǎn)物的意見，又要經(jīng)過察看的辦法找出用戶在使用中碰到的成績。

05 幾點(diǎn)履歷

1. 版本辦理

起首有一個(gè)利用手冊基線版本，在第一次寫完跋文錄如今利用手冊對應(yīng)的體系版本。然后依據(jù)體系的晉級情況，會(huì)漸漸往利用手冊中增長內(nèi)容，此時(shí)需紀(jì)錄每次都增長了哪些內(nèi)容，對應(yīng)了體系的哪些版本。

由于體系更新后不一定每次都偶爾間立刻更新利用手冊，并且當(dāng)利用手冊的范圍大到一定水平，再去查對手冊跟體系的區(qū)別，將泯滅多量的時(shí)間且利用起來極度繁瑣。

可在手冊中增長一個(gè)末節(jié)對此舉行專門紀(jì)錄，寫明手冊版本、變動(dòng)人、變動(dòng)時(shí)間、變動(dòng)內(nèi)容。如有必要可增長稽核人及稽核時(shí)間。

2. 明白/聲明看法

將體系中特出名詞舉行表明。這些內(nèi)容在體系計(jì)劃之初應(yīng)該有干系形貌，可依據(jù)必要舉行摘錄。明白了看法才干順暢相反，并且很多成績本身也是不曉得看法才產(chǎn)生的。

3. 格式一致

主要是為了便利閱讀。查察起來文檔雅觀，查找干系內(nèi)容也比力便利。寫之前先定好標(biāo)準(zhǔn)，稽核文檔時(shí)作為稽核項(xiàng)。修要文檔前先看一下別的章節(jié)，不至于每次增長內(nèi)容有效新的格式。文檔格式主要有底下兩種。

1. 文檔格式。文檔標(biāo)題、要文、表頭號內(nèi)容格式一致。
2. 表達(dá)格式。好比形貌按鈕時(shí)一致用，形貌體系提示時(shí)一致用“”等等，這個(gè)在手冊內(nèi)一致即可。

4. 別的情勢的利用手冊

1. 頁面內(nèi)的提示筆墨關(guān)于容易產(chǎn)生疑問的場合，用簡略的提示筆墨表明。可以直接寫在頁面上，也可以增長小圖標(biāo)，點(diǎn)擊后查察提示；依據(jù)提示的緊張水平舉行計(jì)劃。筆墨一定要簡略易懂。
2. 稀有成績解答這個(gè)模塊可在利用手冊中增長，也可以在體系中提供干系頁面。體系中提供頁面的上風(fēng)在于隨時(shí)可查察，并且可以依據(jù)用戶如今的頁面，將與頁面干系的成績排在前方。
3. 視頻經(jīng)過錄制視頻舉行解說，干系于筆墨更容易了解，可作為利用手冊的增補(bǔ)。
4. 簡化體系的利用邏輯。

最好的利用手冊是不必利用手冊用戶上手即會(huì)用。利用手冊是體系的一局部，那么手冊的抱負(fù)形態(tài)是沒有手冊。經(jīng)過優(yōu)化體系、將提示融入體系等等辦法可向這個(gè)抱負(fù)困難前行。

本文由 @率然 原創(chuàng)公布于各位都是產(chǎn)物司理。未經(jīng)允許，克制轉(zhuǎn)載

題圖來自Unsplash，基于CC0協(xié)議

該文看法僅代表作者本人，各位都是產(chǎn)物司理平臺(tái)僅提供信息存儲(chǔ)空間辦事。