本編の目次 › 第2部 要件定義と設計 › ドキュメント駆動開発
AI駆動開発の実運用ノート No.43コード変更と文書更新を同じコミットに縛る
AI と併走してチケット販売サービスを本番運用まで到達させた記録を、そのまま文字に残しています。今回は第2部「要件定義と設計」から、「ドキュメント駆動開発」のお話です。
その仕組みが「同一コミット強制」です。コードの変更と文書の更新を、同じコミットに縛ります。
やり方はこうなります。 まず「どのコードが、どの文書のオーナーか」を機械が読める表にします。 そのうえで、金銭・災害復旧・スキーマ・法務——乖離が致命的な領域だけは、文書を直さなければコミット自体を拒否します。それ以外の領域では、関連文書を提示するだけにとどめます。
すべてをブロックにすると運用が壊れるので、痛い領域だけを強制するのがポイントです。
「あとで文書を直そう」は必ず忘れます。私も忘れます。だからコードと文書を機械で束ねました。
この回の出典
つづく