如何写好操作类说明文档

一、缘由

之前在人人都是产品经理的平台上写过一年文章，是关于如何设置三级菜单的操作类说明书。开始写作的目的是要记录下这个方法。为了实现这个功能，查找了很多资料，为了复盘总结，特意写了这篇文章并发表到人人都是产品经理平台。因为是第一篇，文章曝光度很高，很多用户收藏和留言，文章发挥了超乎预期的作用，非常高兴。但有点不理解的是，评论区有人说实现不了。因为工作繁忙的原因，没有特别深入地和评论者沟通，而且个人觉得用户肯定是没有按照我写得步骤操作，所以实现不了。最近一次画原型，涉及到三级菜单交互，突然间做不出来这个交互了，回过头去看当时那篇操作说明，费了很大劲才搞明白。猛然发现自己在写操作说明书时考虑的还不周全，存在以下几个问题。一是文档结构不合理，操作步骤不清晰，没有做到结构清晰。二是没有特别说明。用户在按照操作手册实现时，在一些容易出错的关键步骤上没有重点强调，导致用户疏漏。三是没有提供源文件。操作说明应该提供源文件，用户查看源文件便可快速基于源文件进行改动。由此，我思考了一个做事过程中非常重要的方法论，就是做任何事都要及时复盘。通过复盘能总结经验，改进做事的方法。

二、正题

说了这么多，也是给自己一个复盘，那么接下来说说如何写操作类说明文档或者操作教程。第一点：规划好文档结构。操作是一个很繁琐的过程，中间的步骤很多，如果文档条理不清晰，结构混乱，很容易让用户失去操作的动力。文档需要先有个大纲，列出大体步骤，其次在每个大纲下详细写出操作步骤。第二点：重点操作重点强调。简单易懂的步骤正常描述，复杂的步骤一定要重点强调。比如在 axure 在做三级操作时，一定不要在动态面板中建动态面板，要在外部建。这种容易出错的步骤就要特别说明。第三点：授人以鱼不如授人以渔。操作是表面，其实质还是内部原理决定如何操作。在描述操作步骤时，重点步骤要说明原理，用户明白了原理后就可以举一反三，触类旁通。特别是 PS 这种复杂的教程，详细说明操作原理。第四点：提供源文件。通过源文件可以看出具体设置，更方便操作。