pr-documentation-uml

Generate documentation and Mermaid diagrams from code changes.

Updated Jan 4, 2026

Search Tags:#automation #documentation #mermaid #pr #diff-analysis #uml #code-change-tracking

One-click install

npx skills add https://github.com/YoungY620/pr-summary-skills --skill pr-documentation-uml

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: pr-documentation-uml
Source: https://github.com/YoungY620/pr-summary-skills/tree/main/pr-documentation-uml
Command: npx skills add https://github.com/YoungY620/pr-summary-skills --skill pr-documentation-uml

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

PRs often involve complex code changes that are hard to summarize clearly. This Skill automates the generation of precise documentation and UML diagrams directly from code changes, saving hours of manual drafting and reducing miscommunication.

Core Features & Use Cases

Mermaid-driven diagrams: Generate class, sequence, state, and architecture diagrams with exact code element names derived from static analysis.
PR-template friendly: Produce sections aligned with PR_TEMPLATE.md so reviews are faster and more reliable.
Diff-aware analysis: Focus on the files touched in a PR, producing diagrams and notes that reflect the changes verbatim.

Quick Start

Activate the skill in your CI/CD workflow, run static analysis on the modified files (e.g., git diff outputs), and paste the generated Mermaid diagrams and explanation into your PR description using the provided templates.