技术写作与文档2010switched.com
2010年度最佳技术写作
The Best Tech Writing of 2010
导读
这篇盘点 2010 年最佳科技写作,并引发了对“科技写作”来源与评选标准的讨论。对写作者来说,它提醒我们好文章未必出自常见科技博客,同时“最佳”不能只靠主观吹捧,需要有明确标准和实质内容。
可以直接用的写作要点
- 01
好科技写作可能来自传统媒体或独立博主,不要只盯着行业科技博客。
- 02
做作品推荐或评选时,要说明标准,避免主观、片面的吹捧。
- 03
科技写作要有真正的“科技”内核,不能写成与技术无关的空泛赞美。
HN 评论精选
高质量科技写作的来源可能不在主流科技博客。
这份榜单不错。我觉得那些常见的科技博客都很弱,大部分好的科技写作来自传统媒体或独立博主。
bl4k查看英文原文
Good list. I thought all of the usual tech blogs have been very weak and most good tech writing is coming from traditional sources or individual bloggers.
质疑评选标准,认为缺乏技术实质的吹捧不配称为最佳科技写作。
这篇主观、片面、没有技术内容的吹捧文章——www.marco.org/769340032——也能算“2010最佳科技写作”?
blinkingled查看英文原文
This subjective and one-sided puff piece with no tech in it - www.marco.org/769340032 - this qualifies as "Best Tech Writing of 2010"?
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选