知识卡片
言简意赅复述法验证理解,技术备忘录只讲一个主题
内容
复述应特意言简意赅以确认真正抓住本质——作者把一堆内容满满的安全架构幻灯片总结为”你很担心这条跨越所有层次的黑线?”,演讲者答”是的”,移除噪声后信息反而更明确。撰写文档同样不是面面俱到,而是讲清楚某个方面——Ward Cunningham的”技术备忘录”要求每份只关注一个主题,反例是维基项目,虽工具良好,却因没突出重点而堆满主题不明的文档。
参考来源
- 位置:《架构师应该知道的37件事》第3章《沟通》之"3.3 重点突出胜过面面俱到"·"3.3.4 言简意赅"与"3.3.5 技术备忘录"(源文件:_epub-src/OEBPS/Text/chapter003.html)
- 结论依据:原文说明"我把演讲者的陈述总结为'你很担心这条从上到下跨越所有层次的黑线?'……通过移除噪声,把声明简化为'黑线'能让信息更加明确",并引用Ward Cunningham"每个备忘录只关注一个主题"的定义,直接支撑本卡结论。
- 原始内容:技术备忘录概念的经典反例就是维基项目,其中满是随意的、大多过时的且主题不明确的文档……而是因为文档撰写者没有突出重点。