技术写作与文档2024ericwbailey.website
《龙与地下城》教会我如何写图片替代文本（alt text）
Dungeons and Dragons taught me how to write alt text
导读
这篇文章借《龙与地下城》的跑团经验来讲网页图片替代文本（alt text）的写法：描述图像不是堆砌细节，而是替看不见图像的人补足理解所需的信息。对写作者来说，它提醒我们凡是“描述”，都要先想清楚读者是谁、需要知道什么、这段文字在整体叙事里承担什么作用。
可以直接用的写作要点
- 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 条写作要点编辑精选