技术写作与文档2015web.cs.ucdavis.edu
数学写作指南
A Guide to Writing Mathematics [pdf]
导读
这是一份加州大学戴维斯分校的数学写作指南（PDF），讲的是怎样把数学论文、证明和解题过程写得让读者读得懂——数学写作同样是写作，句子、结构和读者意识一样重要。适合需要写公式、写证明、写技术文档的写作者对照阅读。
可以直接用的写作要点
- 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 条写作要点编辑精选