其他2020cs.tufts.edu
用工程方法学习技术写作
Learning technical writing using the engineering method (2016)
入门 · 约 25 分钟读完前置知识：基本编程经验、技术写作基础、工程迭代思维
导读
这篇 2016 年的论文探讨如何用“工程方法”来学习技术写作，把写作当作一项可拆解、可训练的工程实践来处理。文档本身的排版与视觉设计相当考究，作者显然精通版面设计，善于通过变化和拆解文本让内容更易读。
HN 关注点：技术写作是工程师的通用技能，加上这篇 PDF 的排版本身就赏心悦目，评论还延伸出了技术写作成熟度的三阶段框架。
HN 评论精选
这几条评论里：补充 2
补充提出技术写作的三阶段成熟度模型：从操作说明，到讲清原因与坑，再到融会贯通、带观点与局限性的高阶写作。
就算你不读链接的大部分内容，这份 PDF 本身的排版也非常赏心悦目，作者显然懂得如何设计、变化和拆分文本，让它更有趣。光是为了快速看一眼就值得。我再补充一点：我能识别出技术写作的三个成熟阶段。阶段一：作者才勉强掌握主题，基本上只是告诉你复现结果或操作流程的步骤；你从中学到东西之后（除非极其复杂或需要留作参考），很少会回头反复研读欣赏这类写作。阶段二：作者做过足够的分析和练习，写作不再只是说明或死板描述，而是叙述他们为什么这样做、要注意哪些坑、不该做什么，开始让你思考下一步。阶段三：技术细节讲得流畅熟练，基础已无可置疑——写作中现在包含有见地的观点，以及对过去尝试、失败原因及其技术历史背景的调侃；会给出关于将遇到哪些困难和方法局限的建议。这种写作信息量极大，你可能在职业生涯中反复回读。
supernova87a查看英文原文
I will say that even if you don't read the bulk of this link, the PDF document itself is a very visually pleasing layout, and the author clearly knows how to design, vary, and break up text to make it more interesting. It's worth a look just to see it briefly. I will just add that I can recognize good technical writing in 3 stages of sophistication: Stage 1) Someone who has barely mastered the topic and is at the most basic level just telling you the steps to reproduce the result or operate the items or workflow. Once you learn from the material presented (unless extremely complex or required to keep as reference), you rarely go back and study and appreciate this kind of writing repeatedly. Stage 2) Someone who has done the analysis and exercise enough that the writing evolves into not just instructions or rote description, but narration through the reasons why they did it this way, the pitfalls to watch out for, what not to do. Starts you thinking about what to do next. Stage 3) Someone whose telling of the technical detail is so fluid and practiced that the basics are unquestioned -- the writing now includes well-informed opinions and jokes about past attempts at the outcome, why they failed and their historical context in technical terms. Gives advice on the difficulties that will be encountered and the limits of the method. The writing is so informative that you may return to read it again and again throughout your career. One of my favorite texts that reaches Stage 3 is Numerical Recipes in C (which unfortunately I don't have much occasion to refer to nowadays), and the way that programming philosophy, advice, and technical instruction combines in that work is very impressive. Also, many of Griffiths' physics texts, who manages to write with both technical and conversational/narrative mastery. If only more writers could be like this.
补充补充了另一篇关于文档分类（四种文档类型）的相关资料。
看起来很有意思，谢谢分享。我最近还发现另一个关于技术写作的帖子也很有用：Four kinds of documentation（附链接）。
burakemir查看英文原文
This looks quite interesting, thanks for sharing. I found the other recent thread on technical writing useful, too: Four kinds of documentation https://news.ycombinator.com/item?id=21289832
历次讨论
- 2020Hacker News 讨论帖217 分 · 7 评
- 2021Hacker News 讨论帖26 分 · 0 评
同领域还值得读
每个好的系统调节器都必须是该系统的一个模型 (1970)
Every Good Regulator of a System Must Be a Model of That System (1970)
这是控制论经典论文（Conant 与 Ashby，1970）：它试图论证，任何“好的”调节器都必须是其所调节系统的模型——即调节器与被控系统之间必须存在同构或模型关系。
其他2018 · 202 分 · 59 评进阶 · 约 45 分钟编辑精选复杂系统如何失效
How complex systems fail (2002)
总结了复杂系统如何失败的若干条经验法则：系统总是在多重故障的边缘运行，事故是多重因素叠加的结果，操作者实际上同时承担着维持生产与防范故障的双重角色，而事后归因往往把事故简化为某个…
其他2017 · 154 分 · 19 评入门 · 约 30 分钟编辑精选如何阅读论文
How to Read a Paper (2016)
介绍如何高效阅读学术论文，提出“三遍阅读法”：先快速浏览摘要、结论和图表把握概览，再理解主要内容，最后深入细节。
其他2017 · 715 分 · 80 评入门 · 约 10 分钟公元 1021 年欧洲人已在美洲存在的证据
Evidence for European presence in the Americas in AD 1021
这篇 Nature 论文用树木年轮定年，并结合公元 993 年宇宙射线事件标记，把纽芬兰 L'Anse aux Meadows 的 Norse 活动精确到公元 1021 年，为欧…
其他2021 · 655 分 · 391 评进阶 · 约 45 分钟一次通古斯级空爆摧毁了约旦河谷青铜时代城市 Tall el-Hammam
A Tunguska size burst destroyed Tall el-Hammam, Bronze Age city in Jordan Valley
研究约旦河谷青铜时代城市 Tall el-Hammam 被毁的原因。
其他2021 · 653 分 · 342 评入门 · 约 45 分钟