界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
数据与研究 · SKILL.md

phase-1-schema

phase-1-schema

【数据与研究】Define project terminology, data structures, entities, and relationships. Triggers: schema, data model, entity, terminology

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

name: phase-1-schema context: fork background: false classification: capability classification-reason: Pattern guidance may overlap with model's built-in knowledge as it improves deprecation-risk: medium effort: medium description: | Define project terminology, data structures, entities, and relationships. Triggers: schema, data model, entity, terminology agent: bkit:pipeline-guide allowed-tools:

  • Read
  • Write
  • Glob
  • Grep user-invocable: false imports:
  • ${PLUGIN_ROOT}/templates/pipeline/phase-1-schema.template.md
  • ${PLUGIN_ROOT}/templates/shared/naming-conventions.md next-skill: phase-2-convention pdca-phase: plan task-template: "[Phase-1] {feature}"

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

我的收藏