Can this skill generate Mermaid diagrams?

Yes, it provides structured templates for creating Entity Relationship Diagrams (ERDs) using Mermaid syntax which can be rendered in many Markdown viewers.

Does it support specific database engines like PostgreSQL or MySQL?

While the default templates are optimized for PostgreSQL 14+, the documentation patterns and schema definitions can be easily adapted for any relational database including MySQL, SQL Server, and SQLite.

Is it useful for tracking database migrations?

Absolutely. The skill includes specific templates for documenting schema migrations, version history, and individual migration scripts to keep your documentation in sync with your codebase.

Can it document non-relational or JSON data?

Yes, it specifically includes sections for documenting JSONB structures and complex metadata patterns often used in modern hybrid database designs.

Database Schema Documentation

Name: Database Schema Documentation
Author: aj-geddes

byaj-geddes

•

Database Management

Generates comprehensive database schema documentation, ERD diagrams, and technical data dictionaries for clear data modeling.

This skill empowers developers to maintain high-quality database documentation by providing structured templates for entity-relationship diagrams (ERDs), table definitions, and index strategies. It is particularly useful during the design phase of a project, during major migrations, or when onboarding new developers to a complex data model. By automating the creation of detailed table relationships, constraints, and SQL views, it ensures that your system architecture is well-documented and easily reproducible for any team member.

Key Features

01Detailed table definitions including data types, defaults, and constraints

0218 GitHub stars

03Templates for documenting database views, stored procedures, and migration history

04Entity Relationship Diagram (ERD) generation using Mermaid syntax

05Documentation for SQL indexes, triggers, and performance optimizations

06Data dictionary creation for complex JSONB structures and Enum types

Use Cases

01Designing and documenting new database features and tables before implementation

02Onboarding new developers to projects with complex relational data models

03Creating technical specifications for database migrations and schema versioning

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add aj-geddes/useful-ai-prompts database-schema-documentation

For use in Claude.ai and ChatGPT

Download Skill