技术写作与文档2025gwern.net编辑精选
科马克·麦卡锡谈如何写科学论文（2019）[PDF]
Cormac McCarthy's tips on how to write a science paper (2019) [pdf]
导读
这份 PDF 是一篇文章，主题是把小说家 Cormac McCarthy 的写作建议用到科学论文写作上：核心观点是学术写作不必和好文笔对立。对写作者来说，它值得阅读的地方在于，它用小说家的眼光审视论文里常见的坏习惯，比如堆砌术语、句子拖沓、结构不清。请注意：本次输入没有提供正文和评论，下面的要点只是根据标题主题概括的通用写作原则，不是对原文内容的转述。
可以直接用的写作要点
- 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 条写作要点编辑精选