知识卡片

文档是指南

普通读书笔记卡 · 1889.a

内容

软件文档应像旅游指南:提供地图、景点、历史文化和实用信息,帮助人快速探索,而不是试图成为静态百科全书。发散:短小、持续更新、指向关键兴趣点的文档,比厚重模板更有用。

参考来源

- 位置:《程序员必读之软件架构》第47章《软件文档即指南》(源文件:OEBPS/text00000_split_061.html) - 结论依据:原文用泽西岛旅游指南类比,明确提出文档应包含地图、景色(兴趣点)、历史文化和实用信息四类内容,而非静态百科全书,直接支持卡片论点。 - 原始内容:"我们应该考虑把辅助文档作为一个不断变化的旅游指南,而不是一个综合的静态历史片断。……1.地图……2.景色……3.历史和文化……4.实用信息……保持短小简洁。"