技术写作与文档2021ognjen.io编辑精选
Stack Overflow 时代的技术博客写作
Technical blogging in the era of Stack Overflow
导读
这篇文章讨论在 Stack Overflow 几乎能秒答一切技术问题的时代，写技术博客还有什么意义。对写作者的价值在于：它提醒你，问答和博客是不同的写作体裁，各有不可替代的功能；而评论区进一步补充了“为自己而写”和“在 SEO 垃圾内容中做出差异”这两条实用理由。
可以直接用的写作要点
- 01
不要把博客当问答来写：SO 回答追求最短、最可直接套用，博客则应展开背景、取舍和试错过程。
- 02
把已有的 SO 回答当作素材库，扩写成文章，补回那些因“离题”被删掉的细节和旁支讨论。
- 03
写作的首要收益是写作者自己：组织信息、验证理解，本身就是一种技术练习。
- 04
当搜索结果被 SEO 内容农场占据时，把一个问题讲透、讲清楚，本身就是竞争力。
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选