技术写作与文档2018offerzen.com
文学编程：用 Emacs Org-Mode 增强你的写作
Literate Programming: Empower Your Writing with Emacs Org-Mode
导读
这篇文章介绍用 Emacs Org-Mode 做“文学化编程”：在同一份文档里交织代码与说明文字，并导出或提取成多种格式。对写作者来说，它展示了如何让工具服务于表达，也提醒我们要权衡协作、版本控制和维护成本。
可以直接用的写作要点
- 01
把说明文字和代码/素材放在同一文档里，按读者理解的顺序组织内容，能让技术写作和教程更清晰。
- 02
选择写作工具时要先考虑协作和交付格式，提前设计好 PDF、HTML、DOCX 等导出流程，避免被单一工具绑死。
- 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 条写作要点编辑精选