システム開発ではデータベースを使うことが多いです。開発のはじまった段階でしっかりしたER図を作っている場合、開発が進んでいる中で生じた仕様変更を常にドキュメントに反映していかなければなりません。これは大きなコストです。 そこで使ってみたいのがSchemaSpyです。SchemaSpyは現在のデータベーススキーマを取得してドキュメントを生成してくれるソフトウェアです。

SchemaSpyの使い方

生成された内容です。テーブル一覧。

カラム。

リレーションは分かりやすく可視化されます。

さらに改善すべきポイントなど。

SchemaSpyを使えばER図を作ったりする手間なく、既存のスキーマから必要なドキュメントが生成できるようになります。きちんと設計を行っているならば、実際に動いているものは正確なドキュメントになるでしょう。作る手間もないのでお勧めです。

SchemaSpyはJava製のオープンソース・ソフトウェア(MIT License)です。

schemaspy/schemaspy: SchemaSpy code home