DDDにおけるドキュメントと図は「通じればいいんだよ」
手段は問題ではない
筆者はUML図、特にクラスとオブジェクト相互作用図を好む
別に自然言語でも通じる
図は万能ではない
図が表現するのは考え方の骨格である
コミュニケーション、説明、ブレインストーミングに向いている
図では概念的な定義は伝わらない
図で要約する
図にテキストで注釈を加えるのではなく、テキストを書いた上で、選び抜かれたシンプルな図を用いて説明するのだ。
設計に関する本質的な詳細はコードで捉える
ドキュメントは補足手段として使う
まず優れたソフトウェアにドキュメントが追従するのは無理ゲー
コードや言語の進化から置いていかれる、と表現してるね
別の言い方をすると「同期しなくなる」
コードと会話を補足するために書く
すでにコードがうまくいやっていることを、ドキュメントでもやろうとするべきではない。
詳細はコードが提供している
同期可能なドキュメントの塩梅は以下
ドキュメントは最小限に留める
その焦点をコードと会話の補足に絞る
図は要約
設計は輪郭
コードは詳細
ドキュメントは補足
こうかなsta.icon
ページ化もしておくか