pr-documentation-uml

Community

Automate PR docs with exact UML diagrams.

AuthorYoungY620
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 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: pr-documentation-uml
Download link: https://github.com/YoungY620/pr-summary-skills/archive/main.zip#pr-documentation-uml

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 223,000+ vetted skills library on demand.