0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

DB設計 テーブル定義書 テンプレート V2

0
Posted at

DB設計 テーブル定義書 テンプレート V2(Claude で更新しました)

はじめに

以前公開した初学者用のテーブル定義書テンプレートを、Claude(Anthropic の AI)を使って V2 に更新しました。

初版は「表を埋めるだけ」のシンプルなものでしたが、使っているうちに

  • PK・FK・NOT NULL を 〇 で手入力するのが地味に面倒
  • SQL(DDL)を別で書くので、定義書と SQL がずれる
  • テーブルが増えると目次や一覧の更新を忘れる

といった困りごとが出てきたので、見やすく・更新しやすくを目標に作り直しています。

AI が使えない環境(会社のセキュリティ上の制限、スクールの課題など)で、ゼロから設計書を書く必要がある方にぜひ使ってほしいです。

参考文献

初版と同じく、データベース研究室様の HP の表をもとにしています。

設計書の構成

Google スプレッドシート 1 ファイルで、以下の 7 シート構成です。

シート 内容
表紙 文書情報・目次・更新履歴。目次はクリックで各シートへ移動できます
共通ルール 命名規則、データ型の使い分け、共通カラム、記入ルール
テーブル一覧 全テーブルの物理名・論理名・用途・更新日(各シートから自動で引きます)
ER図 テーブル間の関連。セル描画の図と Mermaid 形式のテキスト
users / orders 記入例のサンプルテーブル
_テンプレート 新しいテーブルを作るときにコピーして使う空のシート

■ 表紙
image.png

■ テーブル一覧
image.png

各テーブル詳細

初版からの主な変更点です。

項目 初版 V2
PK / FK / NOT NULL / 一意 〇 を手入力 チェックボックス
データ型 手入力 プルダウン(直接入力も可)
No. 手入力 物理名を入れると自動採番
PK・FK の見分け なし PK 行は橙、FK 行は紫に自動で色が付く
インデックス なし 専用の欄を追加
SQL 別途手書き カラム定義から DDL を自動生成

DDL は CREATE TABLE + PRIMARY KEY + FOREIGN KEY + CREATE INDEX まで式で組み立てているので、セルをコピーしてそのまま実行できます。定義書を直せば SQL も直る、という状態になります。

■ カラム定義
image.png

■ DDL
image.png

使い方

  1. スプレッドシートを開き、「ファイル」→「コピーを作成」で自分の Drive に保存します
  2. 表紙の文書情報(システム名・作成者など)を埋めます
  3. 「_テンプレート」シートを右クリック → コピーして、シート名を物理名にします
  4. カラムを記入すると No.・色・DDL が自動で付きます
  5. 「テーブル一覧」に 1 行追加して完成です

細かい約束事は「共通ルール」シートにまとめてあるので、迷ったときはそちらを見てください。

テンプレート

以下からコピーして使ってください。

初版(V1)はこちらです。

最後に

今回は Claude に「見やすく、更新しやすく」とだけ伝えて、構成の提案からスプレッドシートの作成までをやってもらいました。自分で作ると面倒で省きがちな自動化(採番・色分け・DDL 生成)まで入れてくれたのが良かったです。

とはいえ、設計書は結局「読む人が SQL を見ずに意味が分かるか」が一番大事だと思っています。AI が使える方も使えない方も、このテンプレートが設計の助けになれば嬉しいです。

こちらより良いテンプレートがあれば、ぜひコメントで教えてください。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?