Agent skill · writing content · aj-geddes
database-schema-documentation
Document database schemas, ERD diagrams, table relationships, indexes, and constraints. Use when documenting database schema, creating ERD diagrams, or writing table documentation.
Why this skill is useful
Provides specific guidelines and templates for documenting database schemas and ERD diagrams that the AI wouldn't reliably generate on its own.
What it needs
About 1k tokens when loaded. Last updated 2026-03-04. 307 stars on the source repository.
What this skill does
Database Schema Documentation Table of Contents Overview When to Use Quick Start Reference Guides Best Practices Overview Create comprehensive database schema documentation including entity relationship diagrams (ERD), table definitions, indexes, constraints, and data dictionaries. When to Use Database schema documentation ERD (Entity Relationship Diagrams) Data dictionary creation Table relationship documentation Index and constraint documentation Migration documentation Database design specs Quick Start Minimal working example: mermaid erDiagram users --o{ orders : places users --o{ addresses : has users --o{ paymentmethods : has orders -- { orderitems : contains orders -- payments : has products --o{ orderitems : includes products }o-- categories : belongsto products --o{ productimages : has products --o{ inventory : tracks // ... (see reference guides for full implementation) Reference Guides Detailed implementations in the references/` directory: Guide Contents --- --- users users products products orders orders orderitems orderitems Enum Types Enum Types, JSONB Structures Best Practices ✅ DO Document all tables and columns Create ERD diagrams Document indexes and constraints Include sample data Document foreign key relationships Show JSONB field structures Document triggers and functions Include migration scripts Specify data types precisely Document performance considerations ❌ DON'T Skip constraint documentation Forget to version schema changes Ignore performance implications Skip index documentation Forget to document enum values
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aj-geddes/database-schema-documentation