技术写作与文档2021developers.google.com编辑精选
Google 的技术写作课程
Technical Writing Course by Google
导读
这是 Google 技术写作课程（第一部分）的页面，适合想系统学习技术写作的读者。评论区没有讨论课程细节，而是提出一个现实问题：文档写得再好，如果同事不读、只要求开会讲解，写作的价值也很难发挥。对写作者来说，这提醒我们把“让人愿意读、找得到、用得上”也纳入写作设计。
可以直接用的写作要点
- 01
技术写作不只在“写清楚”，还要考虑目标读者是否会主动读、能否快速找到关键信息。
- 02
当读者反复要求口头讲解时，可以把这当作文档可发现性和可读性的反馈信号。
- 03
即使有演示视频，文字文档仍要假设读者不会按顺序细读，尽量降低阅读门槛。
HN 评论精选
文档写作之外，还要解决“别人不读文档”的传播和使用问题。
很好的资源。写作显然是重要工作，但我想听听如何让别人读手册。我在一个大机构，其他开发者不仅不读我写的帮助文档，还直接发消息要求开个会，把文档里的内容再讲一遍。即使我录了演示视频也一样。你们怎么解决这个问题？
stonecharioteer查看英文原文
Great resource. While writing is clearly an important task, I would like to hear opinions on making others read the manual. I'm at a big org and not only do other Devs not read the help I've written, they just shoot out messages asking for a session to explain exactly what's in the document. This is true even if I've recorded a demo video. How do you tackle this problem?
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选