設計書ディレクトリ

このディレクトリは、本プロジェクトの設計書を管理します。

目的

• 開発者が「何を作りたいのか」「どういった機能が欲しいのか」を実装前に明確にする
• 機能・画面の仕様を後から参照・理解できるようにする
• AI駆動開発においてClaudeが読み込むコンテキストとして活用する

ディレクトリ構成

docs/
├── README.md              # このファイル
├── features/              # 機能設計書
│   └── _template.md       # 雛形
├── screens/               # 画面設計書
│   └── _template.md       # 雛形
├── api/                   # API設計書
│   └── _template.md       # 雛形
└── database/              # DB設計書
    └── _template.md       # 雛形

設計書の種類と使い分け

種類	対象	作成タイミング
機能設計書	ユーザーストーリー・要件・受け入れ条件	新機能の開発前
画面設計書	画面レイアウト・コンポーネント・状態遷移	UI実装前
API設計書	エンドポイント・リクエスト/レスポンス仕様	バックエンド実装前
DB設計書	テーブル定義・カラム・リレーション	スキーマ変更前

ディレクトリ・ファイル命名規則

各ドキュメント種別の配下にドメイン名フォルダを作り、その中に設計書ファイルを置く。

docs/features/orders/orders.md        # 注文管理 機能設計書
docs/screens/orders/list.md           # 注文 一覧画面
docs/screens/orders/detail.md         # 注文 詳細画面
docs/screens/orders/create.md         # 注文 登録画面
docs/screens/orders/edit.md           # 注文 編集画面
docs/api/orders/orders.md             # 注文 API設計書
docs/database/orders/orders.md        # orders テーブル設計書

設計書を書くときのガイドライン

1. 雛形（_template.md）をコピーして作成する
2. 不要なセクションは削除してよい。必要に応じてセクションを追加してもよい
3. 実装が完了したら status を 完了 に更新する
4. 仕様変更があったら設計書も同時に更新する