Generating Database Documentation

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 engin...

BbgnsurfTech/claude-skills-collection·0installs25stars

SKILL.md

Full skill instructions

Overview

This skill empowers Claude to create detailed database documentation from existing database schemas. It leverages the database-documentation-gen plugin to automate the process, saving time and ensuring consistency. The generated documentation includes ERD diagrams, table relationships, and detailed information about database objects.

How It Works

Activation: Claude recognizes the user's request for database documentation, ERD diagrams, or a data dictionary, triggering the database-documentation-gen plugin.
Schema Analysis: The plugin connects to the specified database and analyzes its schema, extracting information about tables, columns, relationships, indexes, triggers, and stored procedures.
Documentation Generation: The plugin generates comprehensive documentation in various formats, including ERD diagrams, data dictionaries, and interactive HTML documentation.

When to Use This Skill

This skill activates when you need to:

Generate documentation for a new or existing database.
Create ERD diagrams for architectural reviews.
Produce a data dictionary for data governance purposes.
Onboard new team members to a database project.

Examples

Example 1: Documenting an Existing Database

User request: "Generate database documentation for the 'users' database."

The skill will:

Activate the database-documentation-gen plugin.
Connect to the 'users' database and analyze its schema.
Generate comprehensive documentation, including ERD diagrams and a data dictionary.

Example 2: Creating an ERD Diagram

User request: "Create an ERD diagram for the 'orders' database."

The skill will:

Activate the database-documentation-gen plugin.
Connect to the 'orders' database and analyze its schema.
Generate an ERD diagram illustrating the relationships between tables in the 'orders' database.

Best Practices

Database Credentials: Ensure Claude has the necessary database credentials to access the database schema.
Database Selection: Clearly specify the database for which documentation should be generated.
Output Format: Consider specifying the desired output format for the documentation (e.g., HTML, Markdown).

Integration

This skill can be integrated with other plugins to further enhance the documentation process. For example, it can be combined with a diagramming plugin to customize the ERD diagrams or with a document generation plugin to create more sophisticated documentation formats.

Install skill

Copy and run in your terminal

npx -y skills add https://github.com/BbgnsurfTech/claude-skills-collection --skill database-documentation-gen

View on GitHub

plugins/claude-code-plugins-plus/backups/skill-structure-cleanup-20251108-073936/plugins/database/database-documentation-gen/skills/database-documentation-gen/SKILL.md

generating-api-contracts
Generate API contracts and OpenAPI specifications from code or design documents. Use when documenting API contracts and specifications. Trigger with phrases like "generate API contract", "create OpenAPI spec", or "document API contract".
0 installs
responding-to-security-incidents
Assists with security incident response, investigation, and remediation. This skill is triggered when the user requests help with incident response, mentions specific incident types (e.g., data breach, ransomware, DDoS), or uses terms like "incident response plan", "containment", "eradication", o...
0 installs
biomni
Autonomous biomedical AI agent framework for executing complex research tasks across genomics, drug discovery, molecular biology, and clinical analysis. Use this skill when conducting multi-step biomedical research including CRISPR screening design, single-cell RNA-seq analysis, ADMET prediction,...
0 installs
tracking-service-reliability
This skill enables Claude to define and track Service Level Agreements (SLAs), Service Level Indicators (SLIs), and Service Level Objectives (SLOs) for improved service reliability. It is triggered when the user needs to establish, monitor, or analyze service performance metrics. Use this skill w...
0 installs