以宜家的说明书为例,说明书上一定会表明有多少零部件,每一个步骤所需要用到什么型号的钉子。只要是按照说明书,认清每一个零部件,按照步骤一步步做下来,拼好一个家具并不是什么难事。
写说明书类型的文章,也得向宜家的说明书一样,事无巨细。作者此时所需要做的就是「复现」,把自己是怎么操作的通过文字的形式复现出来。(也就是写作的根本中所说,要弄清楚「我在为谁写作」)。如果再贴心一点就是配上带有标注的图片。
具体来说是两点:
首先,把读者当成「傻子」,尤其是涉及到具体操作步骤的。读者不会觉得啰唆,最怕的是产生疑惑,然后痛恨地骂着:「怎么从上一步到这一步的?你特么的说不清楚写个毛线!」
我作为读者去查看某些大佬的技术博客时时长就感到绝望,我是傻子啊,我不会啊,写明白点,写清楚点啊。
当然,因为人家是大佬,站在人家的角度,可能已经是写的很明白了。但这也是最大的问题,没有站在读者的角度去写说明书。
其次,读者要看的既然是说明书,作者既然写的是说明书,就别介绍无关内容。比如,我想介绍 Heptabase 的基本用法,关于 Heptabase 的背景介绍、发展历史就属于无关内容。
读者不需要从说明书中了解产品的背景,这不是说明书所需承载的内容。说明书就要直截了当,我只需要介绍 Heptabase 的界面是什么样,界面中的每一个按钮是干什么的。