home / skills / ntaksh42 / agents / plantuml-diagram

plantuml-diagram skill

safe

This skill generates PlantUML diagrams (class, sequence, activity, component) from textual specs to visualize system architecture quickly.

npx playbooks add skill ntaksh42/agents --skill plantuml-diagram

Review the files below or copy the command above to add this skill to your agents.

Files (1)

SKILL.md

1.1 KB

---
name: plantuml-diagram
description: Generate PlantUML diagrams including UML class, sequence, and component diagrams. Use when creating UML diagrams or system architecture visualizations.
---

# PlantUML Diagram Skill

PlantUML記法でUML図を生成するスキルです。

## 主な機能

- **クラス図**: UML class diagrams
- **シーケンス図**: Interaction diagrams
- **アクティビティ図**: Workflow diagrams
- **コンポーネント図**: Architecture diagrams

## クラス図

```plantuml
@startuml
class User {
  +String id
  +String name
  +String email
  +login()
  +logout()
}

class Order {
  +String id
  +Date createdAt
  +Float total
  +addItem()
  +checkout()
}

User "1" -- "*" Order : places
@enduml
```

## シーケンス図

```plantuml
@startuml
actor User
participant Frontend
participant Backend
database Database

User -> Frontend: Login
Frontend -> Backend: POST /api/login
Backend -> Database: SELECT user
Database --> Backend: User data
Backend --> Frontend: JWT token
Frontend --> User: Success
@enduml
```

## バージョン情報
- Version: 1.0.0

Overview

This skill generates PlantUML diagrams for UML class, sequence, activity, and component views. It produces ready-to-render PlantUML source that you can paste into PlantUML tools or automation pipelines. Use it to quickly turn system designs and interactions into visual diagrams.

How this skill works

Provide a description of the model, actors, components, or interactions you want to visualize and the skill returns PlantUML source code. It supports class relationships, sequence flows, activity workflows, and component topology, with options for labels, multiplicity, and basic styling. The output is plain PlantUML text that you can render with any PlantUML-compatible tool or integrate into documentation pipelines.

When to use it

Designing or documenting object models and relationships (class diagrams)
Illustrating runtime interactions between components or services (sequence diagrams)
Mapping business processes or workflows (activity diagrams)
Visualizing system architecture and component dependencies (component diagrams)
Generating diagrams for README, design docs, or architecture reviews

Best practices

Describe entities, attributes, and key methods clearly when requesting class diagrams
List participants and the sequence of messages with directions for sequence diagrams
Specify start/end points and decision branches for activity diagrams
Provide component names, interfaces, and connections for architecture diagrams
Ask for minimal, focused diagrams first, then iterate to add detail

Example use cases

Convert a service interaction description into a sequence diagram to show API calls and data flow
Document domain entities and associations as a class diagram for onboarding new developers
Sketch a business process as an activity diagram for stakeholder review
Map microservice components and their dependencies as a component diagram for deployment planning
Produce PlantUML snippets to embed into technical documentation or automated diagram generation pipelines

FAQ

Can I get diagrams in image formats?

The skill returns PlantUML source. Use a PlantUML renderer or integration (CLI, server, or editor plugin) to convert the source into PNG, SVG, or other image formats.

How do I include relationships and multiplicity in class diagrams?

Provide relationship details (e.g., 1..*, aggregation, composition) and the skill will emit the appropriate PlantUML syntax with labels and multiplicity.