tableに対し自然言語のドキュメントを書くべき
DBのtable設計は、ドキュメントがないと後から読む人が理解するのがかなり難しい table名とcolumn名と型と制約だけで全てを説明し切るのは困難
当たり前にDB内には使用するコードも書かれていないので読み解くのも大変
そのDBにアクセスする側のコードを片っ端から読んでいかないといけない
プログラムのドキュメントが無いのとは比べ物にならないぐらい読み解くのが困難
DBはそもそもリファクタが難しい
tableの情報量が少なすぎると、さらに難しくなってしまう
DBは寿命が長い
故に今後ずっと同じ人がメンテするとは限らない可能性が高い
table構造はそこまで頻繁に変わるわけでもないので、ドキュメントとの乖離も起きづらい
以下のようなものをちゃんと書く
そのtableの責務
各columnの責務
なぜそのcolumnが必要なのか
その型を使う理由
その制約を使う理由