Schema Doc Sync

Schema Documentation Sync Skill

Purpose: Automatically update database schema documentation when Prisma schema changes. Maintains consistency between code and docs.

Trigger

When: After migration.skill completes OR prisma/schema.prisma is modified Context Needed: Schema diff, affected tables, existing docs MCP Tools: mcp_payment-syste_query_docs_by_type, read_file, replace_string_in_file

Schema → Doc Mapping

Update Process

1. Detect changes - Parse schema diff
2. Identify affected docs - Map models to schema docs
3. Load existing docs - Read current content
4. Update tables - Modify table definitions
5. Update stats - Recalculate schema_stats
6. Bump version - Increment patch version
7. Update date - Set last_updated to today
8. Update ER diagram - Modify FULL-ER-DIAGRAM.md

Table Format

### TableName

| Column     | Type     | Constraints             | Description        |
| :--------- | :------- | :---------------------- | :----------------- |
| id         | String   | PK, CUID                | Unique identifier  |
| createdAt  | DateTime | NOT NULL, DEFAULT now() | Creation timestamp |
| name       | String   | NOT NULL                | Display name       |
| merchantId | String   | FK → Merchant           | Owner reference    |

Frontmatter Updates

# Auto-update these fields
last_updated: "2026-01-26" # Today's date
version: "1.0.1" # Bump patch

# Recalculate these
schema_stats:
  total_tables: 5 # Count models
  total_columns: 45 # Count fields
  total_indexes: 12 # Count @@index

ER Diagram Update

When models change, update PlantUML in FULL-ER-DIAGRAM.md:

' Add new entity
entity "NewModel" {
  *id : String <<PK>>
  --
  createdAt : DateTime
  name : String
}

' Add relation
NewModel ||--o{ OtherModel : has

Validation

After sync:

• Doc version incremented
• last_updated is today
• Table columns match schema
• Indexes documented
• Relations accurate

Reference

• 03-DATABASE-SCHEMA-TEMPLATE.md
• FULL-ER-DIAGRAM.md
• DATABASE-DESIGN.md