写作方法2022cbloomrants.blogspot.com
图书馆里的写作顿悟（2015）
Library Writing Realizations (2015)
导读
这是程序员 cbloom 从写库（library）文档中总结的若干条“醒悟”，核心是：没人读文档，大家只看一页快速上手，然后直接复制粘贴示例代码。对写作者来说，它讲的是同一个道理：读者用“照做”代替“阅读”，所以你给出的第一个例子就是你的正文。任何写教程、写说明、写操作指南的人都值得一读。
可以直接用的写作要点
- 01
把示例代码当正文写：读者只会照抄你给的第一段示例，所以要确保它本身就是正确、可直接使用的做法。
- 02
开头要极简、聚焦“怎么跑起来”：一页快速上手比完整文档更可能被读完，其余细节放后面。
- 03
默认参数和典型场景优先：教程里用特殊参数演示“高级用法”，读者抄走后只会困惑，然后去搜索引擎找答案。
- 04
别指望读者从头读到尾：把关键信息埋进示例、注释和源码中，让随手翻到的人也能找到线索。
同类还值得读
被低估的工程技能：把文章写好
Undervalued Engineering Skills: Writing Well
这篇文章讨论为什么“写得好”是被低估的工程能力，以及它如何在团队协作、系统设计和职业发展中持续带来回报。
写作方法2019 · 1,109 分 · 371 评4 条写作要点编辑精选每行只写一句话：让写作和修改都更轻松的排版法
Writing one sentence per line
这是 Derek Sivers 的一篇短文，主张写作时每行只放一个句子，而不是按段落排版。
写作方法2022 · 849 分 · 297 评4 条写作要点编辑精选书面沟通是远程工作的超级能力
Written communication is remote work super power
这篇文章讨论远程工作中书面沟通的价值，评论区则补充了异步与同步沟通的适用场景，并提醒读者：备忘录、结论先行、结构化命令格式等书面沟通传统早已有之。
写作方法2020 · 831 分 · 190 评4 条写作要点编辑精选如何写出有用的文字
How to Write Usefully
保罗·格雷厄姆在这篇文章里给"有用的写作"下了一个可操作的公式：有用≈重要×新颖×正确×清楚，任一项为零，整篇文章就等于零；他还主张敢下确定判断、删掉让自己心虚的句子。
写作方法2020 · 821 分 · 285 评4 条写作要点编辑精选如何写得更清楚、想得更清楚，并学会复杂材料（PDF）
How to write more clearly, think more clearly, and learn complex material [pdf]
这份 PDF 讨论如何把文章写清楚、把思路理清楚，并用写作来学习复杂材料。
写作方法2022 · 779 分 · 153 评4 条写作要点编辑精选