アジャイル
生きたドキュメント
Living Documentation
読み：いきたどきゅめんと
実装やテストとの照合を通じて、現在のシステムの振る舞いを説明し続ける資料です。
01初心者向け
まず意味をつかむ
作成時だけ正しかった仕様書は、変更が重なると実物とずれます。確認できる例やテストと結び付け、今どう動くのかを分かる状態に保ちます。
02実務者向け
仕事でどう使うか
関係者が読める具体例と自動確認を対応付け、実装変更時にまとめて更新します。確認の失敗や仕様の未確定部分を見えるようにし、利用目的に応じて説明も整えます。
03専門家向け
判断を一段深める
自動生成された一覧が、そのまま役立つ文書になるわけではありません。業務上の意図、適用条件、例外の説明を補い、自動確認で覆えない範囲も明示します。
IN PRACTICE
具体例で考える
架空の割引計算で、代表的な料金例を仕様と自動テストで共有し、料金改定時には結果の変化を検知して例と説明を一緒に改訂します。
理解を助けるための架空の例です。共有する仕様例
自動確認の結果
現在の挙動の説明
三者の整合を保つ関係で、単なる文書生成手順ではありません。
ここは誤解しやすい
自動テストが通っていても、読めない資料や古い目的の説明は残り得ます。
この知識を、組織の力へ。