Doc Add Class Diagram
Table of Contents
When to use this skill
When a user asks to add or refresh a PlantUML class diagram —
either for one component (e.g. ores.utility) or the system-level
architecture diagram at projects/modeling/ores.puml.
How to use this skill
- Validate the target. The component must exist under
projects/; the system diagram lives atprojects/modeling/ores.puml. If the modeling folder is missing, create it (mkdir -p projects/<component>/modeling). - Read the source. For a component diagram, the
.hppfiles underinclude/are primary; glance atsrc/for architecturally significant dependencies. For the system diagram, every component'sinclude/ores.<component>/<component>.hppcarries the namespace@briefdescription. - Author the diagram following the conventions in PlantUML class diagram conventions — skeleton, namespace handling, class styling, members + notes, relationships, generators, test suites, layout.
- Validate by running the diagram target — see How do I generate PlantUML diagrams?. Fix any PlantUML syntax errors.
- Self-check against the evaluation checklist in the conventions doc (no class-to-namespace arrows, stereotype order, consistent colours, syntax valid).
Recipes
- How do I generate PlantUML diagrams? — build / preview loop.
Reference
- PlantUML class diagram conventions — the styling rules and evaluation checklist.
- plantuml-er-modeler — sibling skill for SQL ER diagrams.
- System Model — the system-level diagram lives here.