tomevault-io 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
- Build Glossary: Map business terms + global standards
- Identify Entities: Determine what "things" exist
- Define Relationships: Relationships between entities
- 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
## 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
| 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
Converted and distributed by TomeVault — claim your Tome and manage your conversions.