全文 2510 字 | 建议阅读 5 分钟
很多人对程序员的一大误解就是——只会撸代码，不会写文档。
但我要说，这是偏见。
厉害的程序员们，不仅文档写得好，还常常有不同一般文学的“文采”。
这种“文采”就叫——强大的逻辑表述能力，而一个写不好文档的程序员，不要说写出高质量的代码了，可能大脑都是混乱的，只能写很多“一次性”代码。
软件工程最大的好处就在于——复用，如果一个程序员不能写出能复用的代码，那他的工作就是一次性的，效率是极其低下的，也就是“一次性”代码。
这样的代码不仅对自己将来没用，同时对别人也是无用的。
| 1.操作指南
当然，今天要来探讨的是如何写好一篇实用型的操作指南，不是代码操作指南。
说到操作指南，不管是类似生活中的使用小技巧，比如，如何修好漏水的喷头，还是类似烹饪一类的烹饪指南，更或者是如何恢复电脑操作系统一类的实用指南，都是操作指南一类。
还有各种家用电器的说明书，也都是操作指南。
操作指南的最大作用就在于，指导我们如何快速对某个物品或某类方法的使用。
于是，很多人就在想，有时，自己也有想过总结一些自己发现的小技巧或小方法，但是不知道该怎么下手。
更不知道到底什么样的操作指南才是既能让别人看明白，还能被夸赞写得好的类型。
其实判断标准很简单，就是按图索骥的做，就能完成一次操作。
很多时候，一份不合格的操作指南，要么夹杂了太多的作者个人观点，要么就是步骤混乱，跳跃性太强，导致看的人越操作越混乱。
真正好的操作指南，就是一个主题，做好一件事就够了，那些要打广告的软文除外。
事实上，我们每个人时时刻刻都会和各种操作指南打交道，有的熟练后，记在心中，下次就能快速使用，有的实在记不住，就需要时常查阅。
那什么是不合格的操作指南呢？
| 2.无用信息过多
一篇操作指南的好坏，直接影响了操作人的操作结果的好坏。
我总结了有三种类型的操作指南是不合格的——
第一种，挂羊头卖狗肉，写着写着变成了吹嘘、打广告或纯粹的软文推广。
这样的文章，我们一定遇见过很多，明明想要解决一个问题，结果搜索出来的内容，除了标题符合外，内容全是不相关的东西。
有时不看还好，对于一些不太懂的人来说，花时间看了，反而是既解决不了问题，甚至把问题搞得更复杂了。
第二种，关键步骤不说，或者只与说一半。
这种类型的操作指南，开头和结尾都写得很漂亮，可是中间一些非常关键的步骤，要么故意不说，要么含糊其辞，当有人操作后提出疑问，还不予回答。
这样写的操作指南，到底意义何在？
第三种，不写具体环境信息，不写错误处理手段，想要显得很通用。
很多时候，操作指南最重要的其实就是具体的环境信息，比如，如何在某个型号的电脑上安装操作系统，虽然说，通用的操作一般都能解决问题，可是对于一些特定的机器，可能会出现意料之外的情况。
如果不说具体的环境信息，很多时候都会出现操作失败，恰恰是这个意料之外的情况，会导致整个操作出现终止。
当然，你会说找专业人士解决不就好了，但是，本可以通过正确的操作指南就能解决的问题，因为一些重要信息的缺失，而花费更多的时间，本身并不是我们所期望的。
| 3.其实很简单
好了，说了不合格的，接下来，我们说说什么是合格的，以及如何才能写出好的。
首先，一篇合格的操作指南，需要具备三要素——
简洁
正确
可操作
简洁，是因为，操作指南的最终目的是为了帮助我们快速的解决一个实用性的问题，所以什么个人观点，感悟，觉得棒棒棒的，就不要写了，应该开门见山直奔主题。
正确，非常重要。如果在写一篇操作指南之前的动机就存在问题，那写出来的操作指南，其实一点用都没有，甚至会误导别人。只有正确的步骤，才能达成正确的结果。
可操作是一篇操作指南的核心，如果写了整整一篇文字，还没有写出关键的地方，操作起来又发生了新的问题，也说不清楚的话，那操作指南就变成了废物指南了。
其次，写操作指南，有三个关键方法——
1、先写背景信息。
比如，软件是哪个版本，做菜需要哪些主料配料等等。
一定不要认为，背景信息是大家的共识，其实，当别人看你的操作指南时，是不知道这些背景信息的，很可能出现不必要的误解。
而有了背景信息，也是限定了操作的范围，即便真的出现了特殊情况，也为分析提供了更好的思考路径。
2、配图是关键。
操作指南如果能配图就尽量配图，同时标注出对应的重点步骤也是很有必要，不仅是给读他的人更好的提示，也是自己重新梳理的好契机。
一张图能传达的信息，有时多过很多文字的含义，对于操作指南来说，配图是关键。
3、每个步骤是经过你实际操作过的真实步骤，同时经得起推敲。
操作指南最重要的就是，每个步骤都是经过实践操作过的，写的人一定要对自己的操作步骤负责，而不是乱说一气。
不要觉得操作步骤少，就不是一篇好的操作指南了，往往好的操作指南，都是说完了该说的，就结束了，和我在这里写的这篇风格是完全不一样的，比如，爱看书的一般会搜索如何将mobi格式转换为epub。
这样的例子还有很多，那些能经得起推敲的操作指南，同样也是另一种具有美感的文章。
最后，有好的想法，不代表就能写好一篇实用性的操作指南。
好的操作指南是不断思考和不断行动的结果，可以说是精华的集合体。
有很多人虽然能处理各种问题，但是不一定都及时总结下来了，而总结下来，并不断改正自己的操作指南，更是不容易的。
我们经常看见什么操作指南2.0，3.0版本，并不是作者闲得没事，而是他们发现了一些可以补充的东西，比如特殊情况，特殊错误该怎么应对，这才是真正的对操作指南负责的表现。
| 持续践行
最近，很多人问我，为什么很多操作指南写得很容易，自己操作起来很麻烦，而当自己真的去写的时候，发现自己很难抓住重点表达出来。
我说，想到做到是一个需要跨越很多的过程，操作指南虽然看上去简单明了，但是要明白里面的内在逻辑联系并不容易。
就像，我们认为现在安装windows已经一键操作了，应该很方便了，可还是有很多人真的操作时遇见各种各样的问题，以失败而告终，为什么？
就是因为说到容易，做到难，当真正下笔去总结，去写的时候，才发现，原来自己并没有想的那么容易就找出关键点了。
所以说，行动是检验方法的唯一标准。
这个方法好不好用，用一下就知道了。
欢迎留言，说说你收藏的那些好的操作指南是什么样的，给你带来了什么改变。
持续践行，从每天完成一件事开始。