Agent skill

phase-1-schema

Define project terminology, data structures, entities, and relationships. Triggers: schema, data model, entity, terminology, 스키마, 데이터 모델, 용어.

View SKILL.md on GitHub Repository
Stars 491
Forks 125

Install this agent skill to your Project

npx add-skill https://github.com/popup-studio-ai/bkit-claude-code/tree/main/skills/phase-1-schema

SKILL.md

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

Category Description Example
Business Terms Internal proprietary terms "Caddy" (golf booking assistant)
Global Standards Industry common or technical standard terms "OAuth", "REST API"
Mapping Business ↔ Global correspondence "Member" = User, "Payment" = Payment

Glossary Template

markdown
## 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

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

Method 2: Add term rules to project CLAUDE.md

markdown
<!-- 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

Level Application Level
Starter Simple (core terms only)
Dynamic Detailed (all entities)
Enterprise Detailed (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

Recommended Agent Skills

Expand your agent's capabilities with these related and highly-rated skills.

popup-studio-ai/bkit-claude-code

phase-5-design-system

491 125
Explore
popup-studio-ai/bkit-claude-code

zero-script-qa

Zero Script QA — test without scripts using structured JSON logging and Docker monitoring. Triggers: zero-script-qa, log testing, docker logs, QA, 제로 스크립트 QA.

491 125
Explore
popup-studio-ai/bkit-claude-code

phase-6-ui-integration

Implement frontend UI and integrate with backend APIs — state management and API clients. Triggers: UI integration, frontend-backend, API client, 프론트엔드 통합, UI 구현.

491 125
Explore
popup-studio-ai/bkit-claude-code

phase-3-mockup

Create UI/UX mockups and HTML/CSS/JS prototypes without a designer. Triggers: mockup, prototype, wireframe, UI design, 목업, 프로토타입.

491 125
Explore
popup-studio-ai/bkit-claude-code

desktop-app

Desktop app development guide — Electron and Tauri for cross-platform apps. Triggers: desktop app, Electron, Tauri, mac app, windows app, 데스크톱 앱.

491 125
Explore
popup-studio-ai/bkit-claude-code

btw

By-The-Way: 작업 중 개선 제안을 즉시 수집하고 관리하는 스킬. Triggers: /btw, /btw list, /btw analyze, /btw promote, /btw stats Keywords: btw, 개선, 제안, suggestion, improve, idea, feedback

491 125
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results