mcpField
P
phase-1-schema

phase-1-schema

github.com/ww-w-aiData & databases60647 installsUpdated 4w ago
Repository

About phase-1-schema

phase-1-schema is a project-planning phase for defining terminology and data structures, intended for teams that need consistent communication with colleagues or AI. It guides glossary creation, entity and relationship mapping, and schema documentation.

Key features

  1. 01Build a business glossary
  2. 02Identify project entities
  3. 03Define entity relationships
  4. 04Design data schemas
  5. 05Structure documentation deliverables

Use cases

  1. 01Standardize business terms across a team
  2. 02Map project entities and their relationships
  3. 03Set up terminology references for Claude Code
  4. 04Organize project planning documents

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/ww-w-ai/bkit-claude-code --skill phase-1-schema

After installing, type/phase-1-schemain Claude Code to confirm it loaded.

Details

From the project README

Phase 1: Schema/Terminology Definition

Define terminology and data structures used throughout the project

Purpose

Unify the language of the project. Ensure all team members (or AI) communicate using the same terms and clearly understand data structures.

What to Do in This Phase

  1. Build Glossary: Map business terms + global standards
  2. Identify Entities: Determine what "things" exist
  3. Define Relationships: Relationships between entities
  4. Design Schema: Define data structures

Glossary

Why is it Needed?

Explaining business terms to Claude Code every time is tedious. Creating a glossary allows:

  • Claude to automatically reference for context understanding
  • Team communication consistency
  • Reduced onboarding time for new team members/AI
Term Categories
CategoryDescriptionExample
Business TermsInternal proprietary terms"Caddy" (golf booking assistant)
Global StandardsIndustry common or technical standard terms"OAuth", "REST API"
MappingBusiness ↔ Global correspondence"Member" = User, "Payment" = Payment
Glossary Template
## 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 Auto-Reference Setup

To have Claude automatically reference the glossary:

Method 1: Include in CLAUDE.md

## Term Reference
For this project's term definitions, see `docs/01-plan/glossary.md`.

Method 2: Add term rules to project CLAUDE.md

<!-- Add to CLAUDE.md -->
Project terms are defined in docs/01-plan/glossary.md.
Always reference when using business terms.

Deliverables

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 Application

  • Plan: Identify what entities/terms are needed
  • Design: Design schema structure, relationships
  • Do: Write documentation
  • Check: Review for omissions/contradictions
  • Act: Finalize and proceed to Phase 2

Level-wise Application

LevelApplication Level
StarterSimple (core terms only)
DynamicDetailed (all entities)
EnterpriseDetailed (per microservice)

Example Questions

"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?"

Template

See templates/pipeline/phase-1-schema.template.md

Next Phase

Phase 2: Coding Convention → Now that terms are defined, define code rules

Comments

Markdown supported