技术写作与文档2022americanscientist.org编辑精选
科学写作的科学(1990)
The Science of Scientific Writing (1990)
导读
这篇文章讨论科学写作的核心原则:写作不只是把内容写完,更要理解读者的预期,让读者能顺畅、迅速地理解文本。对写作者来说,它提醒我们清晰表达是一种可训练的技能,也能反过来帮助自己理清思路。
可以直接用的写作要点
- 01
不要以为把想说的内容全部写进去就算完成,要站在读者角度检查他们能否顺利理解。
- 02
按读者的预期来组织句子和段落,把关键信息放在读者最容易接收的位置。
- 03
修改和澄清文字的过程,也能反过来改善自己对观点的组织。
- 04
科学写作可以当作一项可学习的专业技术,重点训练清晰、连贯和读者意识。
HN 评论精选
写作要从“内容写完”转向“读者能理解”,清晰表达还能反过来整理思路。
这是对我所有职业沟通影响最大的一篇文章。读之前,我以为邮件或文档只要把所有想覆盖的内容都写进去就算完成了;它教会我在写作中体谅读者。如果写作能帮助作者澄清想法,那么把文字写清楚也能改善你自己组织思想的方式。
giogadi查看英文原文
This is the single most influential article on ALL my professional communication. Before reading this article I used to consider my emails/documents/etc finished as soon as they included all of the content I wanted to cover. This taught me empathy for the reader in writing. And if writing can help the writer clarify their ideas, then clarifying your writing can even improve how you organize your own thoughts.
Gopen 的思路与 Williams 等清晰写作传统相通,科学写作者可优先读 Williams 的书。
George Gopen 与 Joseph Williams、Larry McInerny 属于同一写作流派。他也写过一本更深入的书,但我觉得那本有点冗长;更推荐 Williams 的《Style: Lessons in Clarity and Grace》,这是我心目中最好的写作书。原则上第二好的是 Thomas 和 Turner 的《Clear and Simple as the Truth》,但它不太适用于科学或技术写作;如果你写随笔,可以读这本。
Tomte查看英文原文
George Gopen hails from the same school of writing as Joseph Williams[1] and Larry McInerny[2]. He has also written a book that dives deeper into things[3]. [1] https://en.wikipedia.org/wiki/Style:_Lessons_in_Clarity_and_Grace [2] https://www.youtube.com/watch?v=vtIzMaLkCaM [3] https://www.goodreads.com/book/show/3393233-the-sense-of-structure Unfortunately, [3] is a bit tedious, IMO, go for [1], which is the best book about writing, bar none. Second best in principle is Thomas' & Turner's "Clear and simple as the truth", but it is hardly applicable to scientific (or technical) writing. If you're thinking about writing essays, get T&T.
理解读者预期是科学写作的关键,能显著提升文本的可读性。
很多年前,这篇文章改变了我的科学写作。它是那种重要却莫名从未在大学里教过的技能。简而言之,理解读者的预期后,你就能写出让读者立刻读懂的文字。
AlexGood查看英文原文
How to write science: many years ago, this piece has transformed my scientific writing. It's one of those vital skills that are mysteriously never taught in college. In a gist, by understanding the reader's expectations, you can write text that the reader will immediately get.
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选