知识卡片
产品文档长存
内容
产品级软件指南描述当前系统如何工作和演化,项目文档只记录某次变化。发散:长期系统若只有项目文档,新人必须考古多年材料;一份产品指南能成为稳定入口。
参考来源
- 位置:《程序员必读之软件架构》第47章《软件文档即指南》(源文件:OEBPS/text00000_split_061.html)
- 结论依据:原文明确区分产品文档与项目文档,指出20年历史的系统若只有项目级文档,新人需要消化大量历史项目材料才能了解产品现状,直接支持卡片论点。
- 原始内容:"我这里指的文档风格是跟所构建的产品有关,而不是创建/改变这个产品的项目。……过去20年中产品发生了巨大的变化,为了解软件当前的状态,要消化相当数量的项目文档。……我建议软件团队为他们构建的每一款软件系统都创建一份软件指南。"