とあるプロジェクトでデータベースのテーブル定義書を作成する必要があったのですが、変更がある度に手動でドキュメントを修正するのは大変面倒なため、自動生成することにしました。 Rails の migration を使って管理しているテーブル群(MySQL)の定義書を PDF で出力するまでのフローを紹介します。 この記事の通りに作成すると以下の様式の定義書になりますが、お好きなようにデザインを変更することもできます。詳細は後述。 全体の流れ rake db:migrate でテーブルを作成/変更する DBのスキーマ構造を XML 形式で出力する XML を HTML に変換する HTML を PDF に変換する の大きく4つの手順で定義書を出力します。 1. rake db:migrate でテーブルを作成/変更する この部分は普段の通りに migration ファイルを記述するだけなのですが