技术写作与文档2021serhack.me编辑精选
如何写一本技术书
How to Write a Technical Book
导读
这篇文章讲如何写一本技术书，重点是把写作流程拆成可执行的步骤。评论区补充了从“直接开写”到出版提案、自出版和营销的实战经验。对写作者来说，它既能降低启动门槛，也提醒你完成与推广同样是写书的一部分。
可以直接用的写作要点
- 01
先动笔，不要等完整计划：确定章节布局后就开始写第一版。
- 02
用 Markdown、Leanpub 这类低摩擦工具，把精力留给内容而不是排版发布。
- 03
动笔前就想清楚目标读者和卖点，因为技术书最难的一环往往是让人知道并愿意读。
- 04
把写书当成一次可完成的长项目，先追求写完和发布，再考虑收益。
HN 评论精选
先开始写、用低摩擦工具；营销是技术书写作之外最难的部分。
这篇文章很好！对我来说，最好的方法就是直接开始写。去年我写了一本关于 Java 库的书《Practical Vavr》，这个想法已经有几周/几个月了，加上 COVID 期间待在家有时间，我就告诉自己现在是时候了。除了书该怎么布局，我没想太多；我觉得这个过程很有意思，就全力去做，发现了 Leanpub 等让流程变得像写 Markdown 一样简单的网站。我认为最难的是书的营销：如何告诉世界你写了它，以及他们为什么应该有兴趣读（并购买）。我只是在网上到处发（主要是 Reddit、Twitter），没怎么大张旗鼓，反正我也不知道怎么做。最后，更多是为了写一本书并完成的体验，而不是赚大钱（尽管我成功让近 100 个完全陌生的人相信内容不错并购买）。
flaie查看英文原文
This is a good article! For me, the best way is just to start writing it. I've written a book about a Java library last year named "Practical Vavr" [1], I had the idea since some weeks/months and with the COVID situation having time at home, just told to myself now is the time. Didn't thought a lot about anything, except for how the book should be laid out, I thought the process was interesting so I went full on it, discovered leanpub and other websites that makes the process easy as just writing some Markdown. I think that the hardest thing is the marketing around the book, how to tell the world you wrote it and why they should be interested in reading it (and buying it). I just posted it here and there on the web (reddit, twitter mainly), didn't made a lot of fuss about it, I don't know how anyway. In the end it was more about the experience of writing one and finishing it, than making big money (even if I was able to reach almost 100 people totally unknown people who were kind enough to trust that the content would be good and buy it). [1]: https://leanpub.com/practical-vavr
技术书出版，尤其自出版，需要可操作建议来避开常见坑。
补充说明：抱歉，我本应评论原文。我喜欢这篇文章，认为它为很多人的写作早期流程提供了良好基础……我写下面的评论是因为我的书主要从这里未覆盖的阶段接续。我正在写一本专门面向技术人员的出版书（已写约 1.8 万字）。我讨论传统出版和自出版，大部分篇幅放在自出版时避免常见坑的可操作建议上。我一直在 newsletter 上预览一些信息（不是书中的形式，只是一些主题）。
dangoor查看英文原文
Edit to add: Sorry, I should have commented on the original article. I like this article and think it presents a good basis for the early part of the process for many people... I wrote the comment below because my book largely picks up after the point covered here. I'm in the midst (about 18k words in) of writing a book about publishing specifically for technical people. I do talk about traditional publishing and self-publishing, with most of the words focused on actionable advice to avoid common pitfalls when self-publishing. I've been previewing some of the information (not in the form in the book, but just some of the topics) on my newsletter: https://kevindangoor.substack.com/
出版提案的起步是技术书作者常见卡点。
这就是我在找的文章！能否请你扩展“寻找出版商”这一节？我一直在尝试为技术书写提案，但不知道从哪里开始。
polska查看英文原文
The article I was looking for! Can you please expand the section of "finding a publisher"? I was trying to write a proposal for a technical book but I don't know where to start.
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选