写完之后,做一次减法
写第一遍时,先把想说的话尽量说出来。修改时,再问自己:哪些句子,删掉也不影响理解?
删掉重复的开场
读者点开一篇教程,通常已经带着一个具体的问题。可以直接从问题和操作开始。
给每一段一个任务
一段话只解释一件事。太长的步骤拆开,太抽象的说明换成例子。
留下必要的细节
简短不等于省略关键条件。版本、前提和容易踩的坑,仍然值得写清楚。
写第一遍时,先把想说的话尽量说出来。修改时,再问自己:哪些句子,删掉也不影响理解?
读者点开一篇教程,通常已经带着一个具体的问题。可以直接从问题和操作开始。
一段话只解释一件事。太长的步骤拆开,太抽象的说明换成例子。
简短不等于省略关键条件。版本、前提和容易踩的坑,仍然值得写清楚。