技术写作与文档2025stylepedia.net编辑精选
Red Hat 技术写作风格指南
Red Hat Technical Writing Style Guide
导读
这是 Red Hat 对外公开的技术写作风格指南（Stylepedia），针对文档工程师规定用词、语气、格式与结构上的统一规范。它值得写作者一读，因为它把“写得清楚”拆成了可以逐条执行的规则，而不是靠个人语感，非常适合用来搭建自己的写作检查清单。
可以直接用的写作要点
- 01
建立自己的术语表：同一个概念在全文里只用一种写法，读者不必猜测两个词是不是一回事。
- 02
优先用短句和主动语态，让句子一读就能看出“谁做什么”，减少理解负担。
- 03
按读者要完成的任务来组织内容，先讲怎么做，再补背景和原理，而不是按系统模块平铺功能。
- 04
把风格要求写成投稿前逐条对照的清单，比写完再凭感觉反复修改更省时间。
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选