技术写作与文档2019usenix.org编辑精选
如何写好（以及如何写坏）一篇系统论文（1983）
How and How Not to Write a Good Systems Paper (1983)
导读
这是一篇 1983 年的经典文章，讲系统（计算机系统方向）研究论文该怎样写、又该避免哪些写法，属于“如何写技术论文”这类方法论文献。由于本次输入只给了标题和链接，没有正文与评论，下面的要点只是围绕标题所做的通用提示，不代表原文具体内容。
可以直接用的写作要点
- 01
把“该怎么做”和“不该怎么做”成对地写出来：在讲正确写法时，配一个反面例子，读者更容易照着改。
- 02
写技术论文时，先想清楚读者是谁、评审要看什么，再决定哪些细节放进正文、哪些放进附录。
- 03
标题和摘要要能一句话说清“问题是什么、贡献是什么”，不要用行话掩盖没有说清的主张。
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选