技术写作与文档2012developer.android.com
Android 官方写作风格指南
Official Android writing style guide
导读
这篇是 Android 官方写作风格指南，核心在讲界面文案如何更清楚、直接地服务用户目标，并用大量正反例说明措辞会怎样影响理解。对写作者来说，它提醒我们：好文案不是把系统内部过程全盘托出，而是站在用户视角组织信息和问句。
可以直接用的写作要点
- 01
写界面或说明文字时，先说用户要完成什么、能得到什么，别解释系统内部如何运作。
- 02
问句要和用户将面对的回答方式匹配：如果有多个操作可选，就用“你想做什么？”而不是“你想关闭它吗？”这类是/否问法。
- 03
信息排序要按读者最关心的内容来安排；数量、结果通常比具体名单更重要，可以分层展示。
- 04
不要把“透明”误解成堆砌技术过程，透明不等于暴露实现细节。
HN 评论精选
界面文案别写实现过程，用户只关心目的和结果。
“你的手机需要与 Google 服务器通信来登录你的账户。这可能需要最多五分钟。”程序员为了做到完全透明，有时会搞混，以为用户真的关心应用是如何完成它需要做的事。
leviathan查看英文原文
"Your phone needs to communicate with Google servers to sign in to your account. This may take up to five minutes" Programmers, in trying to be completely transparent, sometimes get confused and think that the user actually cares how the app is doing what it needs to do.
文案语序会影响听感，但信息层级更应按用户关心程度来设计。
他们比较了“包括 Larry Page 在内的另外 77 人 +1 了这条”和“Larry Page 和其他 77 人 +1 了这条”。后者确实听起来更好，但我怀疑大多数用户更关心点赞数而不是某个人，因为个人通常并不特别值得注意。我更愿意把这两部分分开——一个更大的图标加点赞数，右边列出人名。
bthomas查看英文原文
They compare "77 other people +1'd this, including Larry Page." to "Larry Page and 77 others +1'd this." The latter definitely sounds better, but I suspect most users care more about # of likes than an individual person, as usually the individuals aren't particularly noteworthy. I'd rather separate these two pieces -- a larger icon with # of likes, and a list of people to the right
问句措辞必须与用户将面对的回答选项一致。
我觉得第三个例子应该是“你想做什么？”而不是“你想关闭它吗？”现在这样写，我会期待一个是/否问题，结果却得到 3 个操作。
RobAtticus查看英文原文
I feel like the third example should be "What do you want to do?" rather than "Do you want to close it?" The way it is now, I expect a Yes/No question, but instead I get 3 actions.
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选