写过数万字的利用手册，聊聊用户使用分析书该怎样写？

用户使用分析书，是为了可以让用户能更明晰地使用产物而编写的。作者提到了一个编写的小本事，就是把它当成一个需求来处理，那么具体要怎样编写，注意哪些细节？作者从明白需求的目标到最初的调停和完满都做出了具体的解说，接待阅读。

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. 页面内的提示笔墨关于容易产生疑问的场合，用简略的提示笔墨表明。可以直接写在页面上，也可以增长小图标，点击后查察提示；依据提示的紧张水平举行计划。笔墨一定要简略易懂。
2. 稀有成绩解答这个模块可在利用手册中增长，也可以在体系中提供干系页面。体系中提供页面的上风在于随时可查察，并且可以依据用户如今的页面，将与页面干系的成绩排在前方。
3. 视频经过录制视频举行解说，干系于笔墨更容易了解，可作为利用手册的增补。
4. 简化体系的利用逻辑。

最好的利用手册是不必利用手册用户上手即会用。利用手册是体系的一局部，那么手册的抱负形态是没有手册。经过优化体系、将提示融入体系等等办法可向这个抱负困难前行。

本文由 @率然 原创公布于各位都是产物司理。未经允许，克制转载

题图来自Unsplash，基于CC0协议

该文看法仅代表作者本人，各位都是产物司理平台仅提供信息存储空间办事。