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

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

01 弁言

邇來主導了幾個項目利用手冊的編寫。有新開發的項目，要重新編寫利用手冊；有中途接辦別的項目，厥后功效迭代，必要更新原利用手冊；有客戶對利用手冊故意見，必要調停；零零散散寫了數萬字的手冊。

但是寫利用手冊大概叫用戶使用分析書可以當作一個需求來處理。既然是需求，那么處理需求的幾個主要步調關于產物司理來說就是得心應手了。

1. 明白需求的目標
2. 明白目標用戶
3. 明白使用場景
4. 構成處理方案
5. 最小代價驗證方案
6. 調停并完滿方案（編寫文檔到這一步就可以完畢了）

02 明白編寫目標、目標用戶、使用場景

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

目標用戶：客服職員、體系用戶（注意約莫會有多個人物，好比辦理員、利用員、被辦理職員等）。

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

03 構成處理方案

針對編寫目標、用戶、場景，總結出利用手冊必備的幾個要素。

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

1. 目次布局

尋常利用手冊會依據不同的人有不同的版本，但是假如為每一局部單獨寫一份，這個事情量就太大了。最幸而寫的時分就按使用人來區分，如此就可以只寫辦理員（擁有體系全部權限）版本，然后將辦理員版本中的局部摘出來即可構成多個版本。

好比一個體系有挪動端和PC端，假如PC端作為辦理、設置功效，給利用員用。PC端是展現，給辦理者用，那么目次可以分挪動端和PC端，然后再分更細的功效；假如同一個用戶既可以在挪動端完成該功效，又可以在PC端完成，那么目次可以依照功效舉行區分。依照如此的邏輯區分就可以到達上述目標。

假如體系目次區分比力明晰，具體的功效可以依照目次來區分。這里to B體系的產物司理應該很熟習。假如不明晰，發起先優化體系目次。大概體系功效本身很嚕蘇，利用手冊可以依照事項來區分。

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

2. 功效概述

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

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

3. 具體利用步調

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

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

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

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

1. 圈出每個步調必要點擊的按鈕的地點
2. 標明第一步點擊何處第二步點擊何處

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

04 驗證并完滿方案

1. 小范圍公布

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

2. 依據反應舉行調停

目標用戶對利用手冊的反應主要有兩個方面。一個是用戶的直接反應，一個是用戶的使用辦法。

用戶閱讀手冊后，可以與用戶相反使意圖見，看何處不容易了解，何處查察起來不便利，以此來調停手冊的布局及表達辦法。別的可以察看用戶怎樣查閱手冊，看針對幾個特別場景（初次使用時的全體閱讀及查詢某個細節時尋覓處理辦法）的使用情況，來發掘文檔約莫存在的優化點。這個相當于既要經過訪談的辦法相反用戶對產物的意見，又要經過察看的辦法找出用戶在使用中碰到的成績。

05 幾點履歷

1. 版本辦理

起首有一個利用手冊基線版本，在第一次寫完跋文錄如今利用手冊對應的體系版本。然后依據體系的晉級情況，會漸漸往利用手冊中增長內容，此時需紀錄每次都增長了哪些內容，對應了體系的哪些版本。

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

可在手冊中增長一個末節對此舉行專門紀錄，寫明手冊版本、變動人、變動時間、變動內容。如有必要可增長稽核人及稽核時間。

2. 明白/聲明看法

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

3. 格式一致

主要是為了便利閱讀。查察起來文檔雅觀，查找干系內容也比力便利。寫之前先定好標準，稽核文檔時作為稽核項。修要文檔前先看一下別的章節，不至于每次增長內容有效新的格式。文檔格式主要有底下兩種。

1. 文檔格式。文檔標題、要文、表頭號內容格式一致。
2. 表達格式。好比形貌按鈕時一致用，形貌體系提示時一致用“”等等，這個在手冊內一致即可。

4. 別的情勢的利用手冊

1. 頁面內的提示筆墨關于容易產生疑問的場合，用簡略的提示筆墨表明?？梢灾苯訉懺陧撁嫔希部梢栽鲩L小圖標，點擊后查察提示；依據提示的緊張水平舉行計劃。筆墨一定要簡略易懂。
2. 稀有成績解答這個模塊可在利用手冊中增長，也可以在體系中提供干系頁面。體系中提供頁面的上風在于隨時可查察，并且可以依據用戶如今的頁面，將與頁面干系的成績排在前方。
3. 視頻經過錄制視頻舉行解說，干系于筆墨更容易了解，可作為利用手冊的增補。
4. 簡化體系的利用邏輯。

最好的利用手冊是不必利用手冊用戶上手即會用。利用手冊是體系的一局部，那么手冊的抱負形態是沒有手冊。經過優化體系、將提示融入體系等等辦法可向這個抱負困難前行。

本文由 @率然 原創公布于各位都是產物司理。未經允許，克制轉載

題圖來自Unsplash，基于CC0協議

該文看法僅代表作者本人，各位都是產物司理平臺僅提供信息存儲空間辦事。