技术写作与文档2024developer.mozilla.org
MDN博客发布一周年
A year of publishing the MDN Blog
导读
这是 MDN(Web 开发文档站点)团队对其官方博客上线一年的运营复盘,讲他们这一年怎么选题、怎么组织写作和发布,以及从中得到的经验。对写作者来说,这类"长期稳定输出"的一手复盘比写作技巧帖更有参考价值:它展示的是一个内容栏目如何持续运转,而不只是单篇文章怎么写。
可以直接用的写作要点
- 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 条写作要点编辑精选