技术写作与文档2019medium.com编辑精选
在亚马逊写文档
Writing Documents at Amazon
导读
这篇帖子以“在亚马逊写文档”为题，但从高赞评论看，内容更像是在讲如何在杰夫·贝索斯的会议上汇报、表现和不出错，而不是纯粹的文档写作方法。对写作者来说，它值得读的点在于提醒我们：写作场景、读者预期和标题承诺必须一致，否则再实用的经验也会被认为“跑题”。
可以直接用的写作要点
- 01
标题要准确兑现内容承诺，避免读者以为是写作指南，读到的却是会议生存手册。
- 02
动笔前先分清写作目的：是在教方法、做汇报，还是在影响决策；场景不同，写法也不同。
- 03
写职场经验时，开头就交代读者能带走什么，别让核心价值被故事和轶事淹没。
- 04
把读者反馈当作检验文章定位的镜子：如果多人觉得“名不副实”，就需要重设标题或结构。
HN 评论精选
指出文章名不副实：名为文档写作，实为会议与向上管理指南。
这篇文章几乎完全不是在讲如何写文档，而更像一本手册：教你在和杰夫·贝索斯开会时如何不搞砸。
uffjedn查看英文原文
This is almost not at all about writing documents, but more about how to not suck at meetings with Jeff Bezos (a manual).
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选