データベーススキーマ文書化

目次

• 概要
• 使用する場合
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

エンティティ関連図(ERD)、テーブル定義、インデックス、制約、データ辞書を含む包括的なデータベーススキーマ文書を作成します。

使用する場合

• データベーススキーマ文書化
• ERD(エンティティ関連図)
• データ辞書の作成
• テーブル関連性の文書化
• インデックスと制約の文書化
• マイグレーション文書
• データベース設計仕様書

クイックスタート

最小限の動作例:

# データベーススキーマ文書化

**データベース:** PostgreSQL 14.x
**バージョン:** 2.0
**最終更新:** 2025-01-15
**スキーマバージョン:** 20250115120000

## 概要

このデータベースは、ユーザー管理、商品カタログ、注文、決済処理を含むeコマースアプリケーションをサポートしています。

## エンティティ関連図

```mermaid
erDiagram
    users ||--o{ orders : places
    users ||--o{ addresses : has
    users ||--o{ payment_methods : has
    orders ||--|{ order_items : contains
    orders ||--|| payments : has
    products ||--o{ order_items : includes
    products }o--|| categories : belongs_to
    products ||--o{ product_images : has
    products ||--o{ inventory : tracks

// ... (実装の詳細についてはリファレンスガイドを参照)
```

## リファレンスガイド

`references/` ディレクトリの詳細な実装:

| ガイド | 内容 |
|---|---|
| [users](references/users.md) | users |
| [products](references/products.md) | products |
| [orders](references/orders.md) | orders |
| [order_items](references/orderitems.md) | order_items |
| [列挙型](references/enum-types.md) | 列挙型、JSONBの構造 |

## ベストプラクティス

### ✅ DO

- すべてのテーブルと列を文書化する
- ERD図を作成する
- インデックスと制約を文書化する
- サンプルデータを含める
- 外部キー関連性を文書化する
- JSONBフィールド構造を表示する
- トリガーと関数を文書化する
- マイグレーションスクリプトを含める
- データ型を正確に指定する
- パフォーマンスに関する考慮事項を文書化する

### ❌ DON'T

- 制約の文書化をスキップする
- スキーマ変更のバージョン管理を忘れる
- パフォーマンスの影響を無視する
- インデックスの文書化をスキップする
- 列挙型の値の文書化を忘れる