phase-1-schema について
phase-1-schemaは、用語とデータ構造を定義するプロジェクト計画のフェーズです。チームやAIとの認識をそろえたいプロジェクト向けに、用語集、エンティティ、関係、スキーマの整理を案内します。
主な機能
- 01業務用語集の作成
- 02プロジェクトのエンティティ特定
- 03エンティティ間の関係定義
- 04データスキーマの設計
- 05文書成果物の構成
活用シーン
- 01チーム内の業務用語を統一
- 02プロジェクトのエンティティと関係を整理
- 03Claude Code向けの用語参照を設定
- 04プロジェクト計画文書を整理
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ ww-w-ai/ bkit-claude-code --skill phase-1-schemaインストール後、Claude Code で/phase-1-schemaを入力して読み込まれたか確認します。
詳細
フェーズ 1:スキーマ/用語の定義
プロジェクト全体で使用する用語とデータ構造を定義します
目的
プロジェクトの用語を統一します。チームメンバー(または AI)が全員、同じ用語を使ってコミュニケーションし、データ構造を明確に理解できるようにします。
このフェーズで行うこと
- 用語集を作成する:ビジネス用語とグローバル標準を対応付けます
- エンティティを特定する:どのような「もの」が存在するかを判断します
- 関係を定義する:エンティティ間の関係を定義します
- スキーマを設計する:データ構造を定義します
用語集
なぜ必要ですか?
ビジネス用語を毎回 Claude Code に説明するのは面倒です。 用語集を作成すると、次のことが可能になります:
- Claude がコンテキストの理解に用語集を自動的に参照する
- チーム内のコミュニケーションに一貫性が生まれる
- 新しいチームメンバー/AI のオンボーディング時間を短縮できる
用語のカテゴリ
| カテゴリ | 説明 | 例 |
|---|---|---|
| ビジネス用語 | 社内独自の用語 | 「Caddy」(ゴルフ予約アシスタント) |
| グローバル標準 | 業界共通または技術標準の用語 | 「OAuth」、「REST API」 |
| 対応関係 | ビジネス用語 ↔ グローバル標準の対応 | 「Member」= User、「Payment」= Payment |
用語集のテンプレート
## Business Terms (Internal Terms)
| Term | English | Definition | Global Standard Mapping |
|------|---------|------------|------------------------|
| Caddy | Caddy | AI assistant that helps book golf rounds | Booking Assistant |
| Round | Round | One 18-hole golf play | Session, Booking |
| Green Fee | Green Fee | Golf course usage fee | Usage Fee |
## Global Standards
| Term | Definition | Reference |
|------|------------|-----------|
| OAuth 2.0 | Authentication protocol | RFC 6749 |
| REST | API architecture style | - |
| UUID | Universal Unique Identifier | RFC 4122 |
## Term Usage Rules
1. Use **English** in code (`Caddy`, `Round`)
2. Use **local language** in UI/docs (Caddy, Round)
3. API responses prioritize **global standards** (`booking_assistant`)
Claude Code の自動参照設定
Claude に用語集を自動的に参照させるには:
方法 1:CLAUDE.md に含める
## Term Reference
For this project's term definitions, see `docs/01-plan/glossary.md`.
方法 2:プロジェクトの CLAUDE.md に用語ルールを追加する
Project terms are defined in docs/01-plan/glossary.md.
Always reference when using business terms.
成果物
docs/01-plan/
├── glossary.md # Glossary (recommended new)
│ ├── Business Terms
│ ├── Global Standards
│ └── Mapping Table
├── schema.md # Data schema
├── terminology.md # (existing) → recommend merging into glossary.md
└── domain-model.md # Domain model
PDCA の適用
- 計画:必要なエンティティ/用語を特定します
- 設計:スキーマ構造と関係を設計します
- 実行:ドキュメントを作成します
- 評価:漏れや矛盾がないか確認します
- 改善:内容を確定し、フェーズ 2 に進みます
レベル別の適用
| レベル | 適用レベル |
|---|---|
| スターター | シンプル(主要な用語のみ) |
| ダイナミック | 詳細(すべてのエンティティ) |
| エンタープライズ | 詳細(マイクロサービスごと) |
質問の例
"What are the core 'things' this project deals with?"
"What are the relationships between users, products, orders...?"
"Are 'member' and 'user' the same or different?"
テンプレート
templates/pipeline/phase-1-schema.template.md を参照してください
次のフェーズ
フェーズ 2:コーディング規約 → 用語が定義できたので、コードのルールを定義します
コメント
Markdown 対応