技术写作与文档2021texmacs.github.io
TeXmacs 与数学写作的艺术
TeXmacs and the Art of Mathematical Writing
导读
这篇文章讨论 TeXmacs——一个基于 TeX 排版引擎、所见即所得的科技写作编辑器,并借此谈数学写作这件事本身。对写作者来说值得一读,因为它把"内容与排版分离""输入方式如何影响写作节奏"这些老问题放到具体工具里检验:数学写作的难点往往不在措辞,而在符号、公式与排版的重重摩擦。
可以直接用的写作要点
- 01
输入数学符号时尽量沿用你已熟悉的语法(^ 上标、_ 下标、Tab 补全希腊字母),把注意力留给推理而不是敲格式。
- 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 条写作要点编辑精选