技术写作与文档2013research.microsoft.com编辑精选
如何写出优秀的学术论文（PDF）
How to write a great research paper [pdf]
导读
这是 Simon Peyton Jones 关于《如何写好研究论文》的幻灯片。评论者认为，其中的建议不仅适用于写论文，也能指导读论文：要显式思考结构、用例子帮助理解；同时提醒写作者，不能让预设结论反过来扭曲研究结果。
可以直接用的写作要点
- 01
先显式搭好论文结构，让读者清楚每一节在整篇论证中的位置。
- 02
给抽象观点配好例子；正文空间不够时，可以把更多例子放进演讲幻灯片。
- 03
如果想法没有按预期走通，要如实呈现，不要让预设结论倒逼实验或数据。
- 04
把“读者会怎么读”当作写作检查清单：结构是否清楚、例子是否足够、论证是否缺失。
HN 评论精选
按结构读论文，并主动寻找缺失的例子或辅助材料。
这些建议不仅适合写论文，也适合读论文。明确思考论文结构能帮我读下去；如果发现缺了东西——比如好例子——我会先去别处找，再继续读。有时作者演讲用的幻灯片比论文本身更有用，因为幻灯片有更多空间放例子；对只看懂一半数学的密集理论论文尤其如此。
tikhonj查看英文原文
This feels like good advice not just for writing a paper but for reading one as well. Explicitly thinking about the structure of a paper certainly helps me get through it. And if something is missing--say, good examples--I know to look elsewhere for them before continuing. Sometimes, finding a slide deck the author of the paper used is more useful than the paper itself just because they have more room for examples! I've found this particularly true for very dense theory papers where I only half-understand the relevant mathematics.
警惕预设结论带来的确认偏误和压力，实验与数据分析尤甚。
我很支持这种方法，但要提醒：当一个想法没有像写出来的那样顺利时，人们可能会为了完成自己的议程而走极端，比如给学生不当压力，让他们得出“正确”结果。在计算机科学和数学里也许较难篡改结果，但在实验工作或数据分析中，我见过学生突然给出符合导师预期的答案。需要某种防范机制；常见答案是科学家的道德和诚信，但心理学家和经济学家会指出存在灰色地带：人们愿意刚刚作弊到能拿奖励，同时保持良心安稳。
mapcar查看英文原文
I am a strong advocate of this method. However, I have to issue a statement of warning that when an idea doesn't pan out like written out, people will go to great lengths to fulfill their agenda (e.g., put undue pressure on their students to come up with the "correct" result). For computer science and mathematics, it may be more difficult to fudge results. But in experimental work or data analysis, I've seen students suddenly come up with a solution that fits their advisor's expectation. There has to be some mechanism to guard against this; the most common answer is the moral character and integrity of the scientist, but psychologists and economists will quickly point out that there are gray areas where people are willing to cheat just enough to get their reward while preserving their conscience.
可结合演讲版学习作者如何口头讲解论文。
演讲版：https://www.youtube.com/watch?v=g3dkRsTqdDA 强烈推荐，Simon 是非常好的讲者。
thirsteh查看英文原文
Talk version: https://www.youtube.com/watch?v=g3dkRsTqdDA Highly recommended. Simon is a very good speaker.
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选