エリック・エヴァンスのドメイン駆動設計を読んでいる ( 4 )

ドキュメントはコードや会話での表現を補わなければならない

 

プログラムは信じられるが、ドキュメントなんて限りなく信用ならんという話。

 

- ドキュメントどころか、プログラム内のコメントさえも同期されなくなることはよくある

- プログラムならあいまいな所は無いし

- 逆に、口頭でのやりとりやホワイトボードでのやりとりのほうが後に残らなくて無害

- コミュニケーションの媒体としてコードに頼ろうとすれば、クリーンで透過的にしようという気になれるし

 

ただし、プログラムだけで仕様を伝えるのは限界がある

 

- その場合のドキュメントは、「コードを補足するもの」にする

- 実際の仕様をもろもろ書き出すわけじゃない

 

どんなドキュメントが良いか

- チームの活動に同期してないなら有害

- コードや会話と用語が一致していること

- 最小限で、コードと会話の補足に止めること

 

実行可能な基盤

正しいことをするだけでなく、正しいことを言うコードを書くこと


説明のためのモデル

- チーム内のモデルは1つであるべき

次は「モデルと実装を紐づける」