One-click install
npx skills add https://github.com/aryanshrai03/readme-ai --skill uml-aryanshrai03
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: uml
Source: https://github.com/aryanshrai03/readme-ai/tree/main/api/skills/uml
Command: npx skills add https://github.com/aryanshrai03/readme-ai --skill uml-aryanshrai03

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing UML diagrams in a consistent, renderable format is hard—especially when you need correct syntax, diagram framing, and relationships that actually map to PlantUML’s model types.

Core Features & Use Cases

  • Generate multiple UML diagram types (class, sequence, activity, state machine, component, use case, deployment, and more) from plain PlantUML text.
  • Ensure render-ready PlantUML structure by enforcing required diagram boundaries and correct code fencing.
  • Support rich UML modeling details including standard PlantUML keywords, arrow relationship syntax, styling via skinparam, colored elements, and notes for explanations.
  • Use a large icon/stencil library in diagrams using mxgraph.* stencil shapes for cloud/architecture-style visuals alongside UML primitives.

Use case example: You can draft a sequence diagram for a login flow using participants and message arrows, then add styled notes to explain authentication decisions and error handling paths.

Quick Start

Create a PlantUML UML diagram by asking an AI to output valid PlantUML text wrapped in a single indented code block fenced as plantuml, with the diagram starting at @startuml and ending at @enduml.

Frequently Asked Questions about uml

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

FAQPage Schema
How do I generate a UML sequence diagram from text?

You can generate sequence diagrams by writing concise PlantUML syntax with participants and message arrows, ensuring the text is wrapped in mandatory @startuml and @enduml boundaries within a plantuml code fence for rendering.

What types of UML diagrams can I create using PlantUML syntax?

PlantUML syntax supports creating class, sequence, activity, state machine, component, use case, deployment, and communication diagrams by utilizing proper UML keywords and relationship arrow syntax for software modeling.

Does PlantUML support adding notes and styling to class diagrams?

Yes, PlantUML supports styling class diagrams using skinparam conventions, colored elements, and explanatory notes to enhance software modeling visuals and clarify relationships within the diagram structure.

Why does my PlantUML diagram fail to render correctly?

PlantUML diagrams fail to render when missing mandatory @startuml and @enduml framing, using incorrect UML keywords or relationship arrow syntax, or lacking proper plantuml code-fence usage around the diagram text.

Can I use architecture stencils and cloud shapes in UML component diagrams?

Yes, you can use architecture stencils in UML component diagrams by utilizing mxgraph.* stencil shapes alongside standard UML primitives to create detailed cloud architecture-style visuals within your software modeling.