技术写作与文档2011pragprog.com
PragProWriMo：这个十一月写一本技术书
PragProWriMo - Write a Technical Book this November
导读
这篇介绍 PragProWriMo：鼓励作者在十一月集中写一本技术书。对写作者来说，它把写书拆成一个有截止日期的挑战；评论还谈到完成书稿本身的价值、把演讲改写成书，以及用漫画等新形式讲技术。
可以直接用的写作要点
- 01
把写书当成一个限时项目：先设定明确的月份或截止日期，集中推进草稿。
- 02
已有的演讲、课程或文章可以改写成书的章节素材，降低从零开始的难度。
- 03
把“写完”本身当作目标：即使暂时没有出版社感兴趣，完成稿仍是可复用的成果。
- 04
技术内容不必只用教科书形式，可以尝试漫画、故事等更适合读者的表达方式。
HN 评论精选
完成书稿的价值不取决于是否被出版社接受。
我两年前做过。完成后我拿它四处找出版社，没人感兴趣。即便如此，这完全值得。
rumblestrut查看英文原文
I did it two years ago. When I was done, I shopped it around. No one was interested. Even still, it was totally worth it.
已有演讲是写书的现成素材，但需要权衡时间投入。
有意思。我很想试着把我那场《Integrating Grails With The Real World》演讲改写成一本 PragProWriMo 的书。不过不确定能否从创业项目中抽时间出来。唉，要做的事太多，时间总不够……
mindcrime查看英文原文
Interesting. I'm tempted to take a stab at turning my Integrating Grails With The Real World talk into a book for PragProWriMo. Not sure if I can justify taking time away from working on my startup project though. sigh Too much to do, never enough time...
可以把技术概念包装成漫画或故事化教程，形式创新值得尝试。
嗯，我刚开始玩一个关于“Fussyspider 小姐”的漫画，她喜欢整理和分类东西；一个朋友建议它可以做成讲解不同排序算法的教程……然后我就看到这个。嗯。不知道他们会不会想要一本漫画式的排序入门。我一直觉得 PragProg 的书比这更硬核，但谁知道呢。
egypturnash查看英文原文
Hmm. I just started playing with a comic about "Miss Fussyspider", who likes to organize and sort things; a friend suggested that it could be a tutorial on different sort algos... and then I see this. HMMM. Wonder if they'd want a comic-book introduction to sorts. I always see the PragProg line as being a bit more hardcore than that but you NEVER KNOW.
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选