技术写作与文档2025passo.uno编辑精选
AI 必须“先读说明书”：为什么技术写作者正在变成上下文策展人
AI must RTFM: Why tech writers are becoming context curators
导读
这篇文章讨论 AI 时代技术写作者的角色变化：大模型要给出可靠答案，得先“读说明书”，也就是依赖结构清晰、可信、最新的文档与知识库。作者认为写作者的价值正从“写文档”转向“策展上下文”——为人和 AI 挑选、组织并维护正确的知识源。值得写作者一读，因为它重新定义了文档写作的目标：不只被人读懂，还要被机器正确取用。
可以直接用的写作要点
- 01
把文档写成可被切分和检索的结构：一节一个概念、标题即结论、术语前后统一。
- 02
为每个关键概念维护唯一的权威定义（单一事实来源），避免同一说法在多处出现版本冲突。
- 03
像策展人一样筛选与标注：标明内容来源、适用范围和更新时间，让读者和 AI 都知道哪些可信、哪些已过时。
- 04
把维护当成写作的一部分，过时文档会成为 AI 的错误上下文，比没有文档更危险。
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选