技术写作与文档2024asciidoctor.org
Asciidoctor：快速文本处理器与发布工具链
Asciidoctor: A fast text processor and publishing toolchain
导读
这是 Asciidoctor 的项目主页——一个基于 AsciiDoc 纯文本标记语言的快速文档处理与发布工具链，能把同一份源文件转换成 HTML5、PDF、EPUB、man page 等多种格式。对写作者来说，它代表的是“用纯文本写作、单一源文件、多端发布”的工作流：文稿与排版分离，便于版本管理和长期维护。
可以直接用的写作要点
- 01
把内容写成纯文本标记（如 AsciiDoc），让文稿与排版分离，方便用 Git 做版本管理和 diff 比对。
- 02
一份源文件通过工具链输出 HTML、PDF、EPUB 等多种格式，避免为每个发布渠道重复维护文稿。
- 03
写作时用结构化的语义标记（章节、交叉引用、注释）而非手工调格式，后期改版和复用成本更低。
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选