datamart-gen-docs

Generate PTTK and TKCSLD design documents as Markdown and DOCX.

1|Updated Apr 7, 2026
One-click install
npx skills add https://github.com/linhlvit/ubck_atomic_design --skill datamart-gen-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: datamart-gen-docs
Source: https://github.com/linhlvit/ubck_atomic_design/tree/main/.claude/skills/datamart-gen-docs
Command: npx skills add https://github.com/linhlvit/ubck_atomic_design --skill datamart-gen-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python-docx, pandoc, @mermaid-js/mermaid-cli, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill eliminates the tedious manual work of creating standardized design documents for Gold/Datamart layers in data warehouse projects, ensuring consistency with UBCK templates and reducing documentation time from hours to minutes.

Core Features & Use Cases

  • 3-Phase Document Pipeline: Automatically generates Markdown for PTTK (Phân tích Thiết kế) and TKCSLD (Thiết kế Cơ sở Dữ liệu) documents, manages review cycles, and converts approved Markdown to formatted DOCX files.
  • Template Compliance: Enforces strict UBCK formatting rules including ERD diagrams, attribute tables with 8/12 columns, and proper Vietnamese terminology for Datamart modules.
  • Use Case: A Data Modeler working on the UBCK Lakehouse project can input HLD and LLD files for a module like TT (Thanh Tra) and instantly produce both analysis and physical design documents ready for stakeholder review.

Quick Start

Use the datamart-gen-docs skill to generate PTTK and TKCSLD documents for the TT module from its approved HLD and Attributes files, then review the generated Markdown in VS Code before proceeding to DOCX conversion.

Frequently Asked Questions about datamart-gen-docs

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

FAQPage Schema
How do I generate standardized design documentation for a data warehouse Gold layer?

The documentation generation pipeline operates in three phases: creating Markdown for analysis and physical design documents, managing review cycles, and converting approved Markdown into formatted DOCX files using pandoc.

What is the best way to automate Datamart documentation while enforcing UBCK formatting rules?

Yes, the pipeline converts approved Markdown design documents into formatted DOCX files using pandoc and python-docx, ensuring the final output meets stakeholder formatting requirements.

How does the Markdown to DOCX conversion pipeline work for physical database design documents?

The documentation generation pipeline operates in three phases: creating Markdown for analysis and physical design documents, managing review cycles, and converting approved Markdown into formatted DOCX files using pandoc.

Can I generate ERD diagrams and ETL lineage tables automatically for a Lakehouse architecture module?

Automating Datamart documentation ensures strict template compliance by enforcing UBCK formatting rules, generating ERD diagrams, and populating 8 to 12 column attribute tables with proper Vietnamese terminology.

Do I need approved HLD and LLD input files before generating physical database design documents?

Yes, approved High-Level and Low-Level Design input files are required prerequisites to accurately generate the physical database design and analysis documents for Datamart modules.

What are the limitations of using python-docx and pandoc for Vietnamese data warehouse documentation?

Limitations include strict adherence to specific UBCK Lakehouse architecture templates, meaning the generated attribute tables and ETL lineage formats may not apply to other banking or enterprise data warehouse frameworks.