Kush's Wiki

Living documentation

#Documentation

Cyrille Martraire が提唱する、ドキュメントをコードや設計と同じペースで進化させ続ける設計アプローチ。単一の真実源(コード/テスト)から生成・照合し、同期が崩れれば検知することでメンテナンスコストを抑える。

良い living documentation の4原則:

  • Reliable: 自動チェックと実装との突き合わせで正確さを保つ
  • Low-effort: テストシナリオなど既存の成果物を土台にする
  • Collaborative: ビジネス・開発・テストの各ロールからの入力を取り込む
  • Insightful: 構造そのものが不確実性や複雑さを浮かび上がらせる