活文档(Living Documentation)

由运行中的系统生成或校验的文档,因而能随系统演进而保持准确。

什么是 活文档(Living Documentation)?

活文档由 Cyrille Martraire 提出,拒绝接受「文档注定会腐化」这一前提。其理念是:把文档当作代码库的产物(提取、生成或持续校验),而不是一份需要有人记得去更新的平行产物。从代码中发现的 C4 模型,以及在 CI 中强制执行的一致性规则,都是这一理念的实例。

相关术语