tblsを試験的に導入してみた

ツール導入前の課題

開発に携わっていると、新機能の追加や不具合の修正等で調査のためにテーブル設計を把握したい時があります。しかし、ある程度歴史のあるサービスのため規模的にテーブルの全体像把握に時間がかかる、かつ補足になるようなドキュメントもありませんでした。また、ドキュメントを新たに作成・更新する場合でも更新にかかるメンテナンスコストから慎重になる必要がありました。

どのような状態を目指していたか

ER図などテーブル設計が把握できるドキュメントをなるべく負担のかからない形で用意できること。

データベーススキーマからドキュメントを自動生成できるため、手動でドキュメントを書く場合と比べて更新にかかるメンテナンスコストが少ないこと。

改善したかった課題はどれくらい解決されたか

おおむね解決されました。

どのような成果が得られたか

導入したプロジェクトでデータベースの全体像を俯瞰して見たい場合、tblsで生成したドキュメントを利用することができるようになりました。また、データベーススキーマのドキュメントを自動生成できるため、ドキュメントの更新にそれほど負担がかからないという点も満たすことができました。

特にありません。

導入難易度が決して高くないので試しに是非使ってみてほしいです。

まだ一部で試験的に導入されている状態のため、他のプロジェクトでも可能なら導入を検討したいです。