agentleFS
Sign inStart free
ww-w-aiww-w-ai/bkit-claude-code/skills/phase-1-schema/SKILL.md

phase-1-schema

Skill605 starsChanged 3 months agoApache-2.0View on GitHub

Define project terminology, data structures, entities, and relationships. Triggers: schema, data model, entity, terminology

3 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Method 2: Add term rules to project CLAUDE.md

    line 96

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
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

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

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free