atomic-gen-docs

Community

Quickly generate UBCK Atomic DB handover docs

Authorlinhlvit
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Manually creating compliant handover documents for UBCK's Atomic Lakehouse database design is time-consuming, error-prone, and inconsistent across different source systems. This Skill automates the entire workflow to produce standardized, review-ready Word documents aligned to UBCK's official template.

Core Features & Use Cases

  • 3-Step Automated Pipeline: Runs a mandatory sample review phase for quick validation, generates full Markdown fragments for all entities, and builds a formatted DOCX file via Pandoc.
  • Standardized Output: Produces compliant Markdown, DBML diagrams, and Word documents that match UBCK's required structure, including correct table formatting, constraint documentation, and physical naming conventions.
  • Use Case: Data modelers working on the UBCK Lakehouse project can use this Skill to generate handover docs for new source systems (FIMS, FMS, IDS etc.) or update existing documents after HLD/LLD adjustments, eliminating manual formatting work.

Quick Start

Use the atomic-gen-docs skill to generate a complete Word handover document for the FIMS source system once its HLD Overview and approved LLD YAML files are ready.

Dependency Matrix

Required Modules

jinja2pyyamlpython-docxpandoc@napi-rs/canvas

Components

scripts

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: atomic-gen-docs
Download link: https://github.com/linhlvit/ubck_atomic_design/archive/main.zip#atomic-gen-docs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 537,000+ vetted skills library on demand.