背景：

用户操作手册是一份指导用户使用产品或服务的重要手册。 一个新系统，需要写用户操作手册，该从何下笔？本篇是一篇教你编写用户帮助/操作手册的指南～

首先，先来看一个反例 ：

这个是我入职的时候，我们公司对ERP系统已有的一个用户操作手册，这个用户操作手册详细的讲明了每一个页面的操作使用说明。

但是看完了之后我还是不太会快速上手使用；倒也不是说我的理解能力薄弱，而是 用户操作手册内容太多太多，没有提炼出重点，以及主流程是哪些 。无法完全理解这个系统。

---

编写用户帮助/操作手册指南

于是，当我独立负责我们公司新系统测试时候，测试后期需要写新系统的用户帮助文档时，我决定按照我的想法来写。 这也是我第一次编写用户帮助/操作手册。

这个是我写的用户帮助/操作手册。

写操作文档需要做以下步骤：

1. 确定受众：首先，必须明确手册的主要读者群体，即使用您的产品或服务的用户。 这将有助于您确定要使用的文档风格和语言。

   譬如我们ERP系统使用受众是：公司内部员工（也可以当成普通用户）描述时尽可能的简单易懂，并且在第一个目录下的文章中写清楚，这个系统是什么，有什么用，我用这个系统能够有什么好处，这个系统有什么功能，它能帮到我什么，能帮我解决什么问题…等，让初次使用的用户留下一个印象，这个系统/工具能否解决他的痛点，是他想要的，才是让他继续使用的动力~

   

2. 列出步骤，快速上手：列出用户如何快速上手的关键步骤，将每个步骤分成易于理解的简单步骤，以确保用户能够轻松地按照手册中的步骤使用~

   层次也要清晰，可以利用文档编辑工具的添加子层级、添加文档、引用链接等，不要把内容都堆到一起；一级标题、二级标题，加粗字体都很有必要。

   
   

3. 使用简单的语言：避免使用技术术语或复杂的语言。 保持语言重点简单明了，使用户能够轻松理解。

   

4. 结合可视化：在手册中添加图片和图表，可以帮助用户更好地理解每个步骤。可视化起来，也可以上传带字幕的视频~

   

5. 添加警告和注意事项：在必要时添加警告和注意事项，以确保用户不会犯错误或造成问题。

   

6. 确认准确性：最后，你需要用户帮助/操作手册中的每个步骤，以确保步骤正确，易于操作，并且能够帮助用户使用系统/工具。

---

最后再分享几点：

1、多借鉴学习成熟的系统/工具写的用户帮助/操作手册，汲取他们的优点 ~

我这里借鉴的操作文档有：

• Worktile 帮助文档：https://help.worktile.com/spaces/sAoIbomH6f/pages/5ffe73544a0d539ad2c7aef9

• Apifox 帮助文档：https://apifox.com/help/

• PingCode 帮助文档：https://pingcode.com/spaces/si4PJHASUg/pages/5fc8642e515b3ac28f58b979

2、帮助文档常更新，对于用户经常问的问题可以整理一篇常见问题合集。

3、我认为好的用户帮助/操作手册，需要：

• 引导用户上手文档（了解系统、快速上手）
• 可视化结合图片、视频
• 目录、层次、标题清晰
• 内容准确，描述易懂
• 用户一看就会，可以帮助用户解决问题