技术写作与文档2011xaprb.com编辑精选
计算机科学学生：学会写作
Computer Science students: Learn to write
导读
这篇博客主张计算机科学学生应当重视写作，因为清晰表达与编程逻辑其实是相通的。评论从课堂教学、哲学课训练和理工科技术写作等角度补充了如何练出简洁、精确、无歧义的写作能力，值得写作者对照自己的训练方式反思。
可以直接用的写作要点
- 01
写作的关键是删繁就简：把一页纸写到刚好，砍掉所有犹豫和废话，这正是'更短的信'的真意。
- 02
编程与写作相通：逻辑句法和结构能力比数学更重要，写作能反过来训练编程思维。
- 03
技术写作要追求精确、无歧义，参与科研并投稿是磨炼这种能力的好途径。
- 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 条写作要点编辑精选