技术写作与文档2022developers.google.com编辑精选
Google 的技术写作课程
Technical Writing Courses from Google
导读
这是 Google 免费技术写作课程（两模块）的页面，评论区把它当作引子，讨论了技术文档该怎么分类、写作规则该怎么理解，以及哪些文档值得当范本。对写作者的价值不在课程本身，而在评论里那套「先定文档目的，再谈写法」的思路，以及几条被反复验证的具体做法。
可以直接用的写作要点
- 01
动笔前先确定文档类型：教程、操作指南、参考、解释四类各有各的写法，别把 how-to 写成长篇手把手教学。
- 02
以主动语态为主，但要弄清原因（明确执行者、句子更短、责任清楚），把它当判断标准而不是教条。
- 03
值得为插图花时间：示意图和解说图往往是读者真正记住的部分。
- 04
找一份你真心佩服的文档（例如 SQLite 的架构文档）当范本，逐段对照自己写的东西模仿。
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选