技术写作与文档2020github.com
Fast.ai 书籍草稿
Draft of the Fast.ai Book
导读
这是 fast.ai 作者把整本教材写成可运行 Jupyter Notebook 的开源图书项目，读者可以在读书的同时直接跑代码。对写作者的价值不在机器学习本身，而在于它示范了一种“边读边做”的写作形态，以及如何把复杂知识拆成可组合的积木教给读者；评论区还顺带提出了合作者署名的问题。
可以直接用的写作要点
- 01
把讲解和可执行的示例放在同一页，读者读完一段就能立刻动手验证，理解会比纯文字深得多。
- 02
不要只教读者现成的结论或模板，要教他们如何组合基本积木自己搭出东西，这样知识才可迁移。
- 03
合著和团队项目中要主动交代每个人的贡献，署名和致谢写清楚，读者和合作者都会更信任这本书。
- 04
选择写作载体时要考虑它能不能承载“动手”这一环，格式本身就是内容体验的一部分。
HN 评论精选
可运行的 Notebook 让代码与讲解同步，是一种值得借鉴的写作形态。
把整本书写成 notebook 是个很棒的想法——代码可以直接运行，并且和正文排在一起。很期待看看，谢谢 Jeremy 和 Sylvain！
chrisa查看英文原文
It's a neat idea to write the entire book as notebooks - so you can have run-able code right in line. Definitely excited to check this out; thanks Jeremy and Sylvain!
好的教学不喂现成答案，而是教读者掌握可组合的基本单元。
推荐没看过的人都去看看。我其实对机器学习没那么感兴趣，只是为了不掉队把热门课程都刷了一遍，但我很喜欢 fast.ai 的一点是：它不只教你现成的、已知的模型，还教你怎么把可微的基础模块组合起来，自己设计神经网络。
cube2222查看英文原文
I recommend everybody who didn’t check those out to do so. Not really being interested in ML, but doing all the available most popular courses to keep up, I really liked how fastai doesn’t just teach you ready and known models, but also how to compose differentiable building blocks to design NN’s yourself.
合作项目里要记得给共同创作者应有的署名和认可。
完全不是想贬低 Jeremy 的出色工作——我是他的铁杆粉丝。但 fast.ai 有两位联合创始人，而 Rachel 在这些讨论里似乎总得不到应有的认可（我不是特指这本书，而是整个项目）。不太清楚为什么；网站上很多内容是她写的，她对整个事业的贡献显然很大。
he11ow查看英文原文
This is not intending to minimize in the slightest the amazing work that Jeremy does - I am a huge fan. But Fast.ai has TWO co-founders, and somehow, Rachel doesn't seem to get any credit in these discussions (not the book specifically, I'm talking about the overall enterprise). Not quite sure why; A lot of the content on the website is written by her, and it's clear she adds a lot of value to the endeavor as a whole.
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选