技术写作与文档2025danielputtick.com
写复盘：我喜欢的一种面试练习（2017）
Writing a postmortem: an interview exercise I like (2017)
导读
这篇文章介绍作者在面试中喜欢用的一道练习题：让候选人写一份事故复盘（postmortem）。对写作者来说，它值得一读，因为它把「把一件复杂的事讲清楚」拆成了可练习的形式：交代时间线、厘清因果、面向不在场的读者说明影响与改进。
可以直接用的写作要点
- 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 条写作要点编辑精选