skillup

技術ブログ

ドキュメント作成

30分で完成! テーブル定義書&ER図 自動作成

投稿日:2015年9月28日 更新日:

現在携わっているプロジェクトでテーブル定義書やER図を作成することに。

えーこういった資料の特徴として、

年月を経るごとに本番との差分ができてしまい、結局だれも見ない・・・なんてことになりがちですよね。

だからできれば手で作るのではなく、データベース自体から作成することができれば楽だな~なんておもっていました。

そしたら、やっぱりありましたね。そういう便利なツールが。

A5M2

URL https://a5m2.mmatsubara.com/

結構有名どころのようで優れたSQLエディタであることに加え、仕様書の作成だったり、テストデータの作成だったりといろいろできるみたいです。

ダウンロードしてきて、ちょこっと使ったのですが、30分ぐらいでテーブル定義書とER図の作成をすることができました。

テーブル定義書作成

説明を書こうかな・・と思ったんですが、下記リンクがキャプチャもきれいにはってあり、自分もこれをそのまま実行しただけなんで、リスペクトの気持ちもかねてそのままリンクを貼っときます。

https://a5m2.mmatsubara.com/tips/er_skeleton/

ここをそのままやればきれいなテーブル定義書ができると思います。

ER図

こつこつ作ることもできるようですが、上記のやり方でテーブル定義書を作って有れば、そのテーブル定義書から一気に作成できるマクロがあります。

よくあるテーブル定義書からER図を生成する

これまたここから引っ張ってきただけなのでリンクを張ります。

マクロもただExcelにベタってはるだけで1文字も変更しなくてよいです。

いやー楽ですね。まあ、手で書くよさとかこういう道具に頼り切ってしまうデメリットも多々あるとは思うのですが・・・

SQLに関しては道具とかほとんど知らずに手だけでやっていたのでこういう道具をとかもちょくちょく調べてみようかなーと思います。

そのほか、下記リンクでもこのツールについて説明していたんでリンクを張っておきます。

これは楽ちん!データベース設計で面倒なテーブル定義書を簡単に作成できるA5:SQL Mk-2

-ドキュメント作成
-, , ,

執筆者:


  1. […] 30分で完成!テーブル定義書&ER図 自動作成 […]

comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

単体テスト仕様書について

おそらく開発者が書きたくないものの筆頭になるかと思う単体テスト仕様書ですが、うまく使うと有益なコミニケーションツールになります。 Contents1 ユーザーのフロー体験・説明書2 前提となるデータ3 …

no image

ドメイン決定&業務フローとの対応確認

Contents1 ドメイン決定2 業務フローとの対応2.1 実際の業務とエンティティ、画面の遷移2.2 ドメインのCRUD分析 ドメイン決定 業務フローを抽出し、エンティティを抽出した段階で次にドメ …

no image

新しいプロジェクトに入った時にやること

新しいプロジェクトに入った時に最初にすべきことややっておくことなど Contents1 仕様理解編1.1 ユーザーの行動遷移の理解1.2 キー系のデータの理解1.3 データグルーピング1.4 サンプル …

no image

コード静的解析ツールを使った際の気づきなど

最近のプロジェクトでコード静的解析ツール(phpcs,phpmd)を使った際の気づきなど コードを書きながら常時エディタがチェックするタイプのものでないとまず無理(保存するたびでも無理だし、コミット時 …

no image

コレクションの頻出処理に関して

PHPでコレクションを使っていますが、慣れると本当に便利ですね・・・まあforeachとかでグリグリやってもいいのですが、無駄にコードが長くなります。 自分がコレクションでよく使う再頻出のメソッドなど …