Featured

generating-database-documentation

This skill enables Claude to automatically generate comprehensive documentation for existing database schemas using the database-documentation-gen plugin. It is triggered when the user requests database documentation, ERD diagrams, or a data dictionary. The plugin supports multiple database engines and generates documentation that includes ERD diagrams, table relationships, column descriptions, indexes, triggers, stored procedures, and interactive HTML documentation. Use this skill when you need to document existing database schemas for team onboarding, architectural reviews, or data governance purposes. The trigger terms include "database documentation", "ERD diagram", "data dictionary", and `/db-docs`.

TL;DR

Generates database documentation, ERD diagrams, and data dictionaries from schema.

What Is It

Creates detailed database documentation from existing schemas.
Extracts table, column, and relationship information.
Produces ERD diagrams and data dictionaries.
Automates schema analysis and documentation generation.

Key Features

Leverages database-documentation-gen plugin.
Generates ERD diagrams and data dictionaries.
Supports multiple output formats (HTML, Markdown).
Analyzes tables, columns, relationships, indexes, triggers, and procedures.
Enables team onboarding and data governance.
Can be integrated with other plugins for enhanced output.
Ensures consistency and saves time on manual documentation.

How to Use

1.Specify the database name or schema to document.
2.Ensure credentials are available for access.
3.Choose desired output format (e.g., HTML, Markdown).
4.Request ERD diagrams or data dictionaries as needed.
5.Combine with other plugins for advanced formatting.
6.Verify schema access and permissions before generation.

Guardrails & Gotchas

MUST have database credentials to access schema.
CRITICAL: specify correct database name.
FORBIDDEN: do not use without proper access rights.
MUST ensure schema is accessible and up-to-date.

Explore More Skills

move-code-quality

@davila7

Analyzes Move language packages against the official Move Book Code Quality Checklist. Use this skill when reviewing Move code, checking Move 2024 Edition compliance, or analyzing Move packages for best practices. Activates automatically when working with .move files or Move.toml manifests.

12.4k

1.1k

1w ago

generating-database-documentation

Explore More Skills

move-code-quality

e2e-testing-patterns

testing-anti-patterns