技术写作与文档2025github.com
养成撰写有意义提交信息的习惯
Show HN: Build the habit of writing meaningful commit messages
导读
这是一个帮助人写 commit message 的小工具：它不替你生成文字，而是通过提问，帮你把脑子里"我为什么这么改"的直觉整理成清楚的话。对写作者来说，它示范了一个通用方法——先对自己提问（改了什么、怎么改、为什么），再开始动笔；也提醒我们，写作往往不是无中生有，而是把已经知道的东西说清楚。
可以直接用的写作要点
- 01
动笔前先自问三个问题：我改了什么、怎么改的、为什么改——把答案说出来，段落结构就自然形成了。
- 02
写作时要想着"半年后的自己"这个读者：他不记得当时的上下文，所以"为什么"必须写出来，不能只写"做了什么"。
- 03
与其让 AI 代笔，不如让它追问你：被问题逼着把模糊的直觉讲清楚，才是真正的写作练习。
- 04
把每天一条提交信息当作最小的写作练习——短文本也能培养"说清楚一件事"的习惯。
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选