skills.rest
linhlvit
linhlvitCOMMUNITY
Explore all skills by this author →
GitHub

atomic-gen-docs

Generate standardized UBCK handover documents from YAML files via Pandoc.

1|Updated Apr 7, 2026
Search Tags:#data-modeling#database-design#docx-generation#dbml#atomic-lakehouse#handover-documentation#UBCK
One-click install
npx skills add https://github.com/linhlvit/ubck_atomic_design --skill atomic-gen-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: atomic-gen-docs
Source: https://github.com/linhlvit/ubck_atomic_design/tree/main/.claude/skills/atomic-gen-docs
Command: npx skills add https://github.com/linhlvit/ubck_atomic_design --skill atomic-gen-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jinja2, pyyaml, python-docx, pandoc, @napi-rs/canvas, and includes scripts (resource) components.

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.

Frequently Asked Questions about atomic-gen-docs

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

FAQPage Schema
How do I automate database handover documentation generation for UBCK Atomic Lakehouse?▼

Automate database handover documentation for UBCK Atomic Lakehouse by processing approved HLD Overview and LLD YAML files through a 3-step pipeline that generates Markdown fragments, DBML diagrams, and formatted DOCX files using Jinja2 and Pandoc.

Can I generate a single DOCX file for multiple source systems like FIMS and FMS?▼

Yes, you can generate DOCX files for individual source systems like FIMS and FMS, or create aggregated multi-source handover packages by processing combined YAML entity and attribute files through the same automated pipeline.

Do I need Pandoc and Jinja2 to convert database design YAML to Word documents?▼

Yes, Jinja2 is required to render Markdown templates from YAML data, and Pandoc 3.0+ is required to convert the rendered Markdown into formatted Word documents matching UBCK official templates.

What is the best way to validate data model consistency before generating full handover docs?▼

Validate data model consistency using the built-in sample review phase, which performs quick validation checks on a subset of entities to catch common data inconsistencies before generating the full handover document.

Why does my DOCX conversion fail when generating UBCK handover documents?▼

DOCX conversion fails during UBCK handover document generation when Pandoc version is below 3.0, or when input YAML files contain data inconsistencies that fail the built-in validation checkpoints before the rendering stage.

Are pre-approved HLD Overview files required to generate UBCK Lakehouse handover docs?▼

Yes, pre-approved HLD Overview files and aggregated atomic attribute and entity YAML files are required inputs to ensure the generated handover documents comply with official UBCK templates and physical naming conventions.

Related Skills

Explore More Data & Analytics Skills→
linhlvitlinhlvit

atomic-review

Validate Atomic HLD designs against BRD definitions and entity registries.

Community
Advanced
AstyanMAstyanM
1

dbml

Design and visualize database schemas as DBML files.

Community
Intermediate
desmondc9desmondc9

markdown-to-docx

Convert Markdown files to DOCX with Mermaid diagrams and a table of contents.

Community
Advanced
Prorise-coolProrise-cool
24

data-modeling

Create conceptual, logical, and physical data models with ERDs and data dictionaries.

Community
Intermediate