知识卡片

简洁是技术写作的核心目标,作家研讨会检验自包含性

普通读书笔记卡 · 2208

内容

读者不是来欣赏文学创造力,而是要理解内容,因此字数越少越好——团队内部编辑通常能减掉20%~30%的字数,”无一分可增不叫完美,无一分可减才是”对技术文章和代码同样适用。检验文章是否自包含的方法是”作家研讨会”:与会者阅读讨论文章,作者只能旁听不能发言,无法靠口头解释弥补没说清楚的地方——这种”被迫沉默”最能暴露文章哪里没写明白。

参考来源

- 位置:《架构师应该知道的37件事》第3章《沟通》之"3.2 写给大忙人"·"3.2.7 简洁明了"与"3.2.8 作家研讨会"(源文件:_epub-src/OEBPS/Text/chapter003.html) - 结论依据:原文说明"我们团队内部的编辑环节通常能减少20%~30%的字数……作者只允许旁听,但不能发言。这种会议模拟了一群人在阅读和讨论一篇文章的情景,同时也能检验这篇文章是否为自包含的",直接支撑本卡结论。 - 原始内容:Saint-Exupéry说过,"无一分可增不叫完美,无一分可减才是",他的这句名言对技术文章(以及这方面的优秀代码)而言尤其适用。