技术写作与文档2015news.ycombinator.com
Ask HN：有哪些写得最好的编程书？
Ask HN: What are some of the best written programming books?
导读
这是 HN 上关于“最好读的编程书”的讨论，起点是 Russ Olsen 的《Eloquent Ruby》：提问者觉得它极其易读，代码、故事和真实案例结合得很好。对写作者的价值在于，讨论中反复指向清晰、简洁、例子具体、照顾外行读者这些可迁移的写作标准。
可以直接用的写作要点
- 01
把技术内容和故事、真实案例交织起来，能显著提升可读性。
- 02
写作时优先追求清晰、简洁、可读，而不是堆砌信息。
- 03
用具体例子说明抽象原则，并让例子能迁移到更广泛的场景。
- 04
照顾没有背景的读者，让内容即使跨领域也能被理解。
HN 评论精选
被推荐的好书普遍具备清晰、简洁、可读、例子可迁移等特点。
Charles Petzold 写的书都很好读，尤其是非微软主题的《Code》和《The Annotated Turing》。《Java Concurrency in Practice》(2006) 虽旧但仍有价值，它清晰地讲 JVM 并发，是 Java、Scala、Clojure 等工程师的必读；写得清楚、好读、简洁。Sandi Metz 的《Practical Object Oriented Design in Ruby》读起来有趣，包含很多在 Ruby 中好用、也能通用于面向对象编程的原则。Kent Beck 的《Smalltalk Best Practice Patterns》值得读，因为其一般原则适用于任何 OOP 语言。Robert Martin 的《Clean Code》很优秀，但需要投入时间；如果时间紧要在 SICP 和《Clean Code》之间选，我会偏向更实用的《Clean Code》，写出可维护的代码最重要。Fogus/Houser 的《The Joy of Clojure》很出色，即使没有 Lisp/Clojure 背景也能消化。
cfeduke查看英文原文
Any book written by Charles Petzold is an enjoyable read, though particularly the non-MS specific titles Code and The Annotated Turing. Java Concurrency in Practice (2006) is older but relevant and clearly describes concurrency on the JVM. A must read for any Java, Scala, Clojure, etc. software engineer; well-written, enjoyable, concise. Practical Object Oriented Design in Ruby by Sandi Metz is a fun read packed with good principles for working in Ruby that are applicable in general to object oriented programming. Smalltalk Best Practice Patterns by Kent Beck is worth a read because the general principles are applicable to any OOP language. Clean Code by Robert Martin is excellent but a time commitment. (If you had to pick between SICP and Clean Code because time is at a premium I'd err on the side of Clean Code for practicality. Writing maintainable code is paramount.) The Joy of Clojure (Fogus/Houser) is excellent and mentally digestable even if you have no Lisp or Clojure background.
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选