技术写作与文档2024logicgrimoire.wordpress.com
编程书作者：请把全部代码放进书里
Programming book authors: put all the code in the book
导读
这是一篇关于编程书写作反模式的短文：作者主张把书里用到的所有代码都完整放进书里，而不是丢到 GitHub 仓库或外部链接上让读者自己去取。对写作者来说，它讲的是一个更普遍的问题——别让读者为了读懂你的文章而离开你的文章。
可以直接用的写作要点
- 01
凡是读者需要看到的示例、数据、代码，都直接放进正文里，不要让读者跳转到外部链接才能理解内容。
- 02
外部链接会失效、仓库会改版、版本会漂移，正文里的内容才是你能控制、能对读者负责的部分。
- 03
每处引用外部材料时都问一句：读者如果不点这个链接，还能不能读懂这一段？不能就补进正文。
- 04
把'完整'放在'简洁'之前：宁可让书厚一点，也不要让读者在书和浏览器之间来回切换、丢掉阅读的连续性。
同类还值得读
编写更好文档的框架
A Framework for Writing Better Documentation
这是 Divio 的文档写作框架，把技术文档按「读者的目标」分成四类：教程（学习导向）、操作指南（问题导向）、参考（信息导向）、解释（理解导向）。
技术写作与文档2021 · 637 分 · 76 评4 条写作要点编辑精选写好一份设计文档
Writing a good design document
这篇 HN 帖子标题为《Writing a good design document》，主题是如何写好一份设计文档；对写作者来说，它值得作为技术写作和结构化说明文的参照。
技术写作与文档2025 · 581 分 · 147 评3 条写作要点编辑精选技术写作课程
Technical Writing Courses
这是 Google 官方免费技术写作课程（两门），讲受众定义、主动语态、短句、文档结构等基础方法。
技术写作与文档2020 · 571 分 · 73 评4 条写作要点编辑精选写出更好的错误信息
Write better error messages
这篇帖子讨论如何写出更好的错误信息，评论补充了开发者场景下的具体做法和真实反面案例。
技术写作与文档2022 · 566 分 · 253 评4 条写作要点编辑精选写一本技术书的经济账
The Economics of Writing a Technical Book
一位技术书作者拆解写书的真实经济账：版税收入往往远低于投入的时间成本。
技术写作与文档2018 · 519 分 · 149 评4 条写作要点编辑精选