技术写作与文档2024web.stanford.edu
EE 364B 的 LaTeX 样式指南 [PDF]（2014）
LaTeX Style Guide for EE 364B [pdf] (2014)
导读
这是斯坦福 EE 364B 课程（凸优化 II）配套的 LaTeX 模板与排版规范文档，用来规定课程讲义和笔记的格式，包括公式、符号、标题与版式的写法。对写作者来说，它是一份很好的技术写作范例：规范的排版和统一的符号体系，能让读者把注意力放在内容本身，而不是花在辨认格式上。
可以直接用的写作要点
- 01
全文统一使用一套符号：同一个量始终用同一个字母表示，新符号首次出现时先定义，不要等到读者自己猜。
- 02
重要的公式单独成行并居中展示；行内公式只用于短小的符号或简单表达式，否则读者会读得很吃力。
- 03
标题和术语的大小写、编号、字体风格要保持一致，让读者能通过版式一眼看出文档结构层次。
- 04
用语义化的标记表达强调（比如用 \emph），不要手动加粗来模拟，这样样式改动时全文会自动统一。
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选