CtrlK
BlogDocsLog inGet started
Tessl Logo

033-architecture-diagrams

Use when you need to generate Java project diagrams — including UML sequence diagrams, UML class diagrams, C4 model diagrams, UML state machine diagrams, and ER (Entity Relationship) diagrams — through a modular, step-based interactive process that adapts to your specific visualization needs. Part of the skills-for-java project

83

Quality

78%

Does it follow best practices?

Impact

Pending

No eval scenarios have been run

SecuritybySnyk

Advisory

Suggest reviewing before use

Optimize this skill with Tessl

npx tessl skill review --optimize ./skills/033-architecture-diagrams/SKILL.md
SKILL.md
Quality
Evals
Security

Java Diagrams Generator with modular step-based configuration

Generate comprehensive Java project diagrams through a modular, step-based interactive process that covers UML sequence diagrams, UML class diagrams, C4 model diagrams, UML state machine diagrams, and ER (Entity Relationship) diagrams using PlantUML syntax. This is an interactive SKILL.

What is covered in this Skill?

  • UML sequence diagram generation for application workflows and API interactions
  • UML class diagram generation for package structure and class relationships
  • C4 model diagram generation at Context/Container/Component levels only (levels 1–3; Code/Level 4 not generated)
  • UML state machine diagram generation for entity lifecycles and business workflows
  • ER diagram generation from SQL schema (DDL, migrations) using PlantUML Chen notation
  • PlantUML syntax for all diagram types
  • File organization strategies: single-file, separate-files, or integrated with existing documentation
  • Final diagram validation with PlantUML syntax checking

Constraints

Before applying any diagram generation, ensure the project validates. If validation fails, stop immediately — do not proceed until all validation errors are resolved.

  • MANDATORY: Run ./mvnw validate or mvn validate before applying any diagram generation
  • SAFETY: If validation fails, stop immediately — do not proceed until all validation errors are resolved
  • BEFORE APPLYING: Read the reference for detailed good/bad examples, constraints, and safeguards for each diagram generation pattern
  • C4 LIMIT: C4 diagrams restricted to levels 1, 2, 3 only (Context, Container, Component); never generate Level 4 (Code) diagrams

When to use this skill

  • Generate UML diagram
  • Create sequence diagram
  • Create class diagram
  • Create state machine diagram
  • Create C4 diagram
  • Generate ER diagram

Reference

For detailed guidance, examples, and constraints, see references/033-architecture-diagrams.md.

Repository
jabrena/cursor-rules-java
Last updated
Created

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.