技术写作与文档2015postgresql.org编辑精选
错误信息风格指南
Error Message Style Guide
导读
这篇是 PostgreSQL 的错误信息风格指南，讨论如何写出清晰、简洁、主动的错误提示，并提醒注意容易引发歧义的“棘手词”。对写作者来说，它虽是技术文档规范，却提供了可迁移的提示语和界面文案写作原则，值得用来训练表达的准确与一致。
可以直接用的写作要点
- 01
写错误提示时优先使用清晰、简洁、主动的语言，让读者一眼看懂问题。
- 02
把容易引起误解的“棘手词”单独列出并统一处理，减少歧义。
- 03
为同类文本建立统一的风格标准，让不同作者写出的提示保持一致。
- 04
每条风格规则最好附上具体理由，而不是只列偏好，这样更容易被理解和执行。
HN 评论精选
主张把清晰的错误信息规范推广为跨软件的通用标准。
我们应该为错误信息建立一个通用标准；这份文档里的若干要点多次让我警醒，理应成为各类软件错误提示的通用做法。
advanderveer查看英文原文
We should think of an universal standard for error messages, some of the points made in this document have caught of guard many times and should be standard practice for errors across all kinds of software.
强调清晰简洁主动的语言，并欣赏规则背后的理由与棘手词清单。
在开发中，我一直赞成清晰、简洁、主动的语言。这些要点很好，而且都附有有力理由；我很喜欢文末那些“棘手词”。
theandrewbailey查看英文原文
In development, I am always in favor of clear, concise, and active language. These are fantastic points with great justifications attached. I really like the tricky words near the end.
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选