笨写作

我们想要表达一件事物时，会受限于自己的知识水平。知识水平低会带来问题 —— 表达不够正确，语焉不详可以使得表达不出错，许多人会以此手段规避错误。知识水平高也会带来问题 —— 处处是术语让外行人听不懂，相关的知识不一定在读者的脑中，这会让寻常人难以读懂表达。

所有的表达都有其受众。哪怕简单的文字，也需要受众识字且有基础的阅读能力；牙牙学语的小朋友只能接受绘本的表达。我们写作的受众是谁？技术文章是给比作者水平更高的人看的吗？

知乎

今天逛知乎看到一个问题 给孩子讲题为什么容易急眼？ - 知乎。

因为你说话喜欢用超链接，你心里有一个库，信息都是从库里调用的，但孩子没有这个库，你一堆超链接发过去全调用失败，你说半天孩子那听到的都是 404 not found。

文字、语言本身就是一种超链接，至少需要读者能理解词语的意思，比如 == 超链接 == 就是一个不那么常见的词。但是我们又不可能长篇大论在这里插入 == 超链接 == 的详细解释。那么这篇文章的受众就具备起码的上网冲浪经验，这些我们眼中的常见词汇不必详细解释。

避免出现文章读一半觉得看不懂、读一半觉得啰嗦没意义，写作前评判文章的受众具备怎样的知识是有必要的。

我的写作

现在看来，我的技术博文往往假设读者是某个技术领域的初学者，大部分博文都是手把手教程，一步一步点击总能看到预想的现象。在没有方法论支持的时候，我已经无意识地注重读者的水平问题了。 骄傲 (‾◡◝)

但是仍然有稍微深入一些的博文，是需要读者具备1水平，就需要大量读者所不具备的前置知识，但又没有相关说明，读者又会四处查找杂乱的资料。

傲慢和懒惰

书本文字受限于篇幅，往往整本书只能着重解决一个问题，而且前置技术都一笔带过。

我认为好的文章是一站式解决方案，如果这个问题是2级别，那么未入门～心转手的读者都应该通过一篇文章解决问题。

得益于软件形式的呈现，一篇文章可以专注描述整体流程，其中的前置知识和细节可以以超链接形式插在某些段落。

写这样一篇好的文章费时费力，而且没什么收益，我也没法真正严格以此要求自己。

但我认为这样的终级标准是没问题的。不这样做就像写作代码不写注释，如果看代码的人能无障碍轻松读懂，那读者的水平可比写作者高很多。

对于技术写作，我不认为 "像诗一样" 是好的评价，诗是简洁有力的文化超链接，诗的解释千人千面，诗的内涵丰富复杂。但对技术，我的要求是尽可能精准的描述，只有通过无数精准的部件，才能拼凑一个精准的技术系统，最好不要有争议和副作用让人挠头。

笨写作

把自己当作笨笨的作者，毫不留情地压榨自己。

把读者当作笨笨的读者，写出猴子能看懂的莎士比亚。

此文由 Mix Space 同步更新至 xLog
原始链接为 https://www.yono233.cn/posts/white/25_4_3_BungleW

Footnotes

火龙果说电影发明的麻将四种境界分别是：筑根、心转手、上层、鬼神，境界逐渐提升。 ↩ ↩

火龙果说电影发明的麻将四种境界分别是：筑根、心转手、上层、鬼神，境界逐渐提升。 ↩ ↩