06-table-documentation

Document Gold layer tables with naming conventions and dual-purpose column descriptions.

5|6|Updated Jan 26, 2026
One-click install
npx skills add https://github.com/databricks-solutions/vibe-coding-workshop-template --skill 06-table-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: 06-table-documentation
Source: https://github.com/databricks-solutions/vibe-coding-workshop-template/tree/main/data_product_accelerator/skills/gold/design-workers/06-table-documentation
Command: npx skills add https://github.com/databricks-solutions/vibe-coding-workshop-template --skill 06-table-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill ensures that all Gold layer tables and columns are documented according to comprehensive, dual-purpose standards, making them understandable for both business users and AI systems.

Core Features & Use Cases

  • Standardized Naming: Enforces consistent naming conventions for tables and columns.
  • Dual-Purpose Descriptions: Creates descriptions that serve both business context and technical implementation details.
  • Metadata Requirements: Defines essential table properties and governance metadata.
  • Use Case: When creating a new dim_customer table in the Gold layer, use this Skill to ensure its documentation clearly explains what each column means to a business analyst and how it's technically implemented for a data engineer or AI.

Quick Start

Apply the 06-table-documentation skill to define comprehensive documentation standards for the Gold layer tables.

Frequently Asked Questions about 06-table-documentation

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

FAQPage Schema
How do I standardize Gold layer table documentation for business users and AI?

Standardize Gold layer table documentation by enforcing consistent naming conventions, dual-purpose column descriptions, and essential metadata. This ensures business analysts understand column meanings while data engineers and AI systems grasp technical implementation details.

What metadata is required for data governance in Gold layer tables?

Required data governance metadata for Gold layer tables includes specific table property definitions, surrogate key usage, and structured YAML schema consultation. These metadata elements facilitate AI understanding and enforce standardized documentation formats.

How do I write dual-purpose column descriptions for data modeling?

Write dual-purpose column descriptions for data modeling by combining business context with technical implementation details. This structured documentation format ensures columns are comprehensible to both business users querying data and engineers maintaining pipelines.

Does this documentation approach require YAML schema consultation?

Yes, YAML schema consultation is required to establish comprehensive documentation standards for Gold layer tables. Adhering to the YAML schema ensures table properties, naming conventions, and surrogate keys meet structured metadata requirements.

When should I enforce naming conventions on Gold layer tables?

Enforce naming conventions on Gold layer tables when creating new dimensional models like dim_customer. Consistent naming standards ensure tables are immediately understandable for business users, data engineers, and AI systems consuming the data.

What is the best way to document surrogate keys in Gold layer dimensional tables?

The best way to document surrogate keys in Gold layer dimensional tables is by defining them within required table properties and dual-purpose column descriptions. This structured approach ensures keys meet governance metadata standards and technical implementation requirements.