06-table-documentation

Enforce Gold layer table documentation standards with dual-purpose descriptions.

1|Updated Jan 22, 2026
One-click install
npx skills add https://github.com/prashsub/vibe_coding_lakehouse_starter_repo --skill 06-table-documentation-prashsub
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: 06-table-documentation
Source: https://github.com/prashsub/vibe_coding_lakehouse_starter_repo/tree/main/data_product_accelerator/skills/gold/design-workers/06-table-documentation
Command: npx skills add https://github.com/prashsub/vibe_coding_lakehouse_starter_repo --skill 06-table-documentation-prashsub

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

Ensures all Gold layer tables and columns are comprehensively documented with dual-purpose descriptions that serve both business users and technical systems, preventing data confusion and improving discoverability.

Core Features & Use Cases

  • Standardized Naming Conventions: Enforces consistent naming for keys, measures, and flags.
  • Dual-Purpose Descriptions: Creates descriptions understandable by both humans and LLMs like Genie.
  • Metadata Requirements: Defines essential table properties for governance and performance.
  • SCD Type 2 Guidance: Provides patterns for documenting slowly changing dimensions.
  • Use Case: When designing a new dim_customer table, use this skill to ensure its documentation clearly explains what each column means to business analysts and how the surrogate key is generated for technical users.

Quick Start

Apply the gold layer documentation standards to the new dim_product table design.

Frequently Asked Questions about 06-table-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document Gold layer tables for both business users and LLMs?

Gold layer table documentation requires dual-purpose descriptions that serve business users and technical systems like Genie. You achieve this by enforcing standardized naming conventions for keys, measures, and flags alongside comprehensive column descriptions.

What is the best way to document surrogate keys in dimensional modeling?

Documenting surrogate keys in dimensional modeling requires explicit metadata explaining the key generation patterns for technical users. This ensures the surrogate key logic is transparent and discoverable alongside the standard dimensional table documentation.

How do I create metadata requirements for SCD Type 2 dimensions?

Creating metadata requirements for SCD Type 2 dimensions involves applying specific documentation patterns for slowly changing dimensions. This standardizes how historical changes are tracked and described within the Gold layer table metadata.

Does YAML schema consultation help with data governance for dimensional models?

YAML schema consultation directly supports data governance for dimensional models by defining essential table properties. This pattern enforces comprehensive metadata requirements, ensuring all Gold layer tables meet standardized governance and performance criteria.

Can I standardize naming conventions for keys and measures in a Gold layer data model?

Yes, you can standardize naming conventions for keys and measures in a Gold layer data model. This is achieved by enforcing consistent naming rules across all tables and columns, which improves data discoverability and prevents confusion.

When do I need dual-purpose descriptions for data modeling metadata?

You need dual-purpose descriptions for data modeling metadata when serving both business analysts and technical systems like LLMs. This approach prevents data confusion and improves discoverability by making column meanings clear to both humans and Genie.