governing-schema-documentation

What problem does it solve?

This Skill addresses the critical issue of inconsistent or missing database schema documentation, which leads to maintenance challenges and knowledge silos.

Core Features & Use Cases

• Standard Enforcement: Defines and enforces documentation standards for tables, columns, constraints, and indexes using PostgreSQL's COMMENT ON syntax.
• Automated Auditing: Provides SQL queries to audit existing schemas for documentation gaps.
• CI/CD Integration: Offers examples for integrating documentation checks into CI/CD pipelines using tools like Atlas.
• Use Case: When establishing new database schemas or auditing existing ones, use this skill to ensure all critical elements are properly documented according to defined standards, improving maintainability and team understanding.

Quick Start

Use the governing-schema-documentation skill to audit the 'public' schema for missing table comments.