技术写作与文档2018pdfs.semanticscholar.org编辑精选
如何撰写技术论文 [PDF]
How to Write a Technical Paper [pdf]
导读
这是一篇讲如何写技术论文的讲义（PDF），评论区的讨论集中在可操作的写作套路上：用四句话搭出摘要骨架，先写粗稿再迭代打磨，并借助几篇经典的论文结构指南和“如何读论文”的方法来反推写作。对需要写摘要、引言或任何需要讲清“问题—方案—价值”的写作者都很有参考价值。
可以直接用的写作要点
- 01
摘要先用四句话写完：陈述问题、问题的后果、你的解决方案、方案带来的效果，得到一个切中要害的骨架。
- 02
把这个四句骨架当作第一版草稿，允许它粗糙，再通过多轮迭代打磨成最终稿。
- 03
在“效果”一句里放具体数字（如提速150%、体积减少75%），让价值可验证、更有说服力。
- 04
先学会读懂好论文的结构（如 Keshav 的《How to Read a Paper》），再反过来模仿它的组织方式。
- 05
如果不知道摘要怎么开头，就套用“现状有问题—问题有代价—我提出X—X带来Y”的因果链。
HN 评论精选
用“问题—后果—方案—效果”四句话搭出摘要骨架，再迭代润色。
多年前我学到一个写摘要的好办法（可惜忘了出处）：摘要第一版只写四句话——第一句陈述问题；第二句陈述问题带来的后果；第三句陈述你的解决方案；第四句陈述方案带来的后果。这样写出的摘要非常切题。有时一次就成，有时要迭代几轮，但四句版是很好的起点。例子一：多数汉堡大到一只手拿不住，这让人难以进食；我们提出一种叫 Hand Burger 的小汉堡，一只手就能拿；实验显示吃汉堡速度最多提升150%。例子二：Node.js 应用的 node_modules 目录常包含同一文件的多个副本，导致目录变大、启动变慢；我们设计了一种模块缓存方案，保证每个文件只留一份；在最常用的 Node.js 应用上目录体积减少75%，启动速度平均提升25%。
adunk查看英文原文
Many years ago I picked up a nice idea on how to write abstracts that efficiently convey the idea of a paper. Unfortunately, I don't remember where I read it, so I can't give proper credit. The idea is that you should write your (first version of the) abstract using only four sentences: Sentence 1: State the problem Sentence 2: State the consequences of the problem Sentence 3: State your solution Sentence 4: State the consequences of the solution This makes a very to-the-point abstract. Sometimes these work right away and sometimes they have to be refined through multiple iterations. If they need further iterations, the four-sentence abstract is a great starting point. Examples: Most hamburgers are larger than what can be held with one hand. This makes them hard to eat. We present a new type of hamburger, called the Hand Burger, that is small enough to hold in one hand. Experimental results show that the Hand Burger increases eating speed by up to 150%. The node_modules directory of Node JS applications often contain multiple copies of the exact same file. This increases the size of the node_modules directory and decreases application startup speed. We have developed a caching scheme for Node JS modules that maintains a single copy of each unique file. This mechanism reduces the size of the node_modules directory by 75% for the most commonly used Node JS applications and increases startup speed by 25% on average. Horse-drawn carriages have a hard time moving on land because of vegetation. This makes travel slow, or outright impossible. We present a novel concept that we call roads. Our measurements show that roads decrease travel time from years to days to reach the 20 most popular destinations throughout the Roman Empire.
论文结构写作已有成熟的“规则/公式/算法”类指南可以直接套用。
我觉得下面几篇文献在这方面很有用：Kording 与 Mensh 的《Ten simple rules for structuring papers》；Baldwin 的《The Baldwin Formula for scientific writing: writing papers and reviews》；O'Connor 与 Holmquist 的《Algorithm for writing a scientific manuscript》。
esalman查看英文原文
I have found the following articles quite useful in this regard: * Konrad P Kording, Brett Mensh, "Ten simple rules for structuring papers", https://www.biorxiv.org/content/early/2017/05/23/088278 * Ian T Baldwin, "The Baldwin Formula for scientific writing: writing papers and reviews", https://www.ice.mpg.de/ext/fileadmin/extranet/dept_itb/The_Baldwin_Formula_for_writing_a_scientific_paper_and_reviewing_papers.pdf * O’Connor Timothy R. and Holmquist Gerald P., “Algorithm for writing a scientific manuscript,”, https://iubmb.onlinelibrary.wiley.com/doi/full/10.1002/bmb.20329
学会高效读论文，也有助于理解论文该怎么写。
也推荐相关的一篇：我所在学校（滑铁卢大学）Keshav Srinivasan 写的《How to Read a Paper》。
adtac查看英文原文
Also relevant: How to Read a Paper from Keshav Srinivasan from my uni (UWaterloo) [1] [1] http://blizzard.cs.uwaterloo.ca/keshav/home/Papers/data/07/paper-reading.pdf
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选