DBのテーブルやビューの役割、構成、制約をまとめるドキュメントってどうやって作りますか？

Question

MySQLを使用したシステム開発を行っています。

各テーブルの役割、データ型や制約、カラムの役割、コードの意味などをまとめたドキュメントを必要としています。

今まではERMasterからエクスポートしたExcelファイルを使用していました。コメントに色々情報を書き込んでいました。しかしいくつか問題が発生しています。

• SQLでコメントを書かないといけない。

ERMasterはテーブルの構成を読み取ってExcelにまとめています。なのでテーブルやカラムの説明を記述したい場合、SQLのコメントに書くしかありません。編集がとても面倒です。

• 教育が面倒

私の職場ではEclipseを使用していません。しかしERMasterを使うためにEclipseをわざわざ用意し、プラグインのインストールが必要です。新人に教えるのにも割りと面倒です。

• 他DBを使用したViewを読み取れない。

これが一番困るんですが、ERMasterは複数のDBに依存するViewをドキュメント化すると例外が発生するようです。

というわけで、ERMasterは大変便利なのですが、他の方法に移行しようと思っています。
名前が解らないのですが、多分テーブル設計書とかDB設計書になると思います。

こういったドキュメントは、皆さんはどうやって作っていますか？

Answer 1

私は「A5:sql mk-2」というツールをよく使います。
DB接続してしまえば、テーブル定義などを出力できるので、
あとは必要な情報を出力したものに足していく感じですかね。

Comments

[usugita_san]

ありがとうございます。一旦このツールを使ってみようと思います。
これならEclipseも必要ないし、便利そうですね。

[usugita_san]

このツールから出力したドキュメントを使用する事にしました。
ありがとうございました。