OpenParable
Skip to content
← Back to skills

Plantuml Syntax

Development
plantuml-syntax

Plantuml Syntax is an Agent Skill for development published in the tractorjuice/arc-kit repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

This skill should be used when the user asks about PlantUML syntax for C4-PlantUML, sequence, class, activity, state, ER, component, deployment, or use case diagrams, rendering errors, layout conflicts, skinparams, or themes.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/tractorjuice/arc-kit/blob/HEAD/plugins/arckit-claude/skills/plantuml-syntax/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/plantuml-syntax, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

PlantUML Syntax Reference

A comprehensive reference for PlantUML diagram types with a focus on C4-PlantUML for architecture diagrams. This skill provides syntax documentation adapted from the SpillwaveSolutions/plantuml project, supplemented with ArcKit-specific C4 layout conflict rules and best practices.

This skill ships reference material, not runnable scripts. Read the relevant reference file with Read, apply the syntax, and write the diagram into the user's artefact. Do not Bash-execute anything from references/ — they are PlantUML/C4 syntax docs, not commands.

Supported Diagram Types

Select the appropriate diagram type and read the corresponding reference file:

TypeReferenceArcKit Commands Using It
C4-PlantUMLc4-plantuml.md/arckit:diagram (C4 Context, Container, Component)
Sequence Diagramsequence-diagrams.md/arckit:diagram (Sequence mode)
Class Diagramclass-diagrams.md—
Activity Diagramactivity-diagrams.md—
State Diagramstate-diagrams.md—
ER Diagramer-diagrams.md—
Component Diagramcomponent-diagrams.md—
Use Case Diagramuse-case-diagrams.md—
Deployment Diagramdeployment-diagrams.md—

Styling & Errors

TopicReference
Common Syntax Errorscommon-syntax-errors.md
Styling Guidestyling-guide.md

C4-PlantUML (Primary Use Case)

The C4-PlantUML reference is the most important file for ArcKit users. It covers:

  • Include URLs for C4 libraries
  • Element syntax (Person, System, Container, Component, and their variants)
  • Boundary syntax (System_Boundary, Container_Boundary)
  • Directional relationships (Rel_Down, Rel_Right, Rel_Up, Rel_Left, Rel_Neighbor)
  • Layout constraints (Lay_Right, Lay_Down, Lay_Distance)
  • LAYOUT CONFLICT RULES — critical rules to prevent rendering failures when layout hints contradict relationship directions
  • Tier-based layout patterns
  • Worked examples for Context, Container, and Component diagrams

For C4 layout science (Sugiyama algorithm, edge crossing targets, declaration ordering), also see the Mermaid skill's c4-layout-science.md — Section 7 covers PlantUML directional hints.

Common Syntax Gotchas

These are the most common PlantUML syntax errors encountered when generating diagrams:

GotchaProblemFix
Rel_Down contradicts Lay_RightLayout engine receives conflicting direction hints for the same element pairEnsure every Rel_* direction is consistent with any Lay_* constraint on the same pair
Missing @startuml/@endumlDiagram fails to render entirelyAlways wrap PlantUML code in @startuml and @enduml
Wrong !include URLC4 macros not found, syntax errors on Person/System/ContainerUse exact URL from plantuml-stdlib: https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml
Generic Rel instead of directionalLayout engine places elements randomly without direction hintsAlways use Rel_Down, Rel_Right, etc. instead of plain Rel
Missing element declarationRelationship references an undeclared element IDDeclare ALL elements before ANY relationships
Spaces in element IDsParser fails on IDs with spaces or special charactersUse camelCase or underscores: paymentApi, payment_api
Nested boundaries without contentEmpty boundaries may cause rendering errorsEnsure every boundary contains at least one element
\n in descriptionsExpects literal \n text but PlantUML renders it as a line breakThis is expected behavior — PlantUML interprets \n as line breaks natively. Use \\n if literal text is needed

ArcKit Integration

This skill handles conversational PlantUML syntax questions — quick lookups, syntax examples, troubleshooting rendering issues, and learning about diagram types.

For formal architecture diagram generation with document control, project integration, layout science, and governance compliance, use the /arckit:diagram command instead. It generates versioned diagram artifacts saved to your project directory with full traceability to requirements and architecture principles.