Database Documentation Gen

What it does

This skill automatically generates documentation for databases. It can analyze database schemas, table structures, and relationships to produce clear and concise documentation suitable for developers and data analysts. The generated documentation includes descriptions of tables, columns, data types, and primary/foreign key constraints.

When to use it

• You need to quickly document a newly created or modified database schema.
• Existing database documentation is outdated or incomplete.
• Onboarding new team members who need to understand the structure of a database.
• Preparing for an audit or compliance review requiring detailed data lineage information.

Key capabilities

• Schema analysis
• Table description generation
• Column description generation
• Data type identification
• Relationship mapping (primary/foreign keys)

Example prompts

• "Generate documentation for the 'customers' table in my PostgreSQL database."
• "Create a schema overview document for all tables in the 'sales_data' database."
• "Document the relationships between the 'orders' and 'products' tables, including primary and foreign keys."

Tips & gotchas

The skill requires access to the database connection details (host, port, username, password) to analyze the schema. Ensure that appropriate permissions are granted for read-only access.