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

  1. Validate the target. The component must exist under projects/; the system diagram lives at projects/modeling/ores.puml. If the modeling folder is missing, create it (mkdir -p projects/<component>/modeling).
  2. Read the source. For a component diagram, the .hpp files under include/ are primary; glance at src/ for architecturally significant dependencies. For the system diagram, every component's include/ores.<component>/<component>.hpp carries the namespace @brief description.
  3. Author the diagram following the conventions in PlantUML class diagram conventions — skeleton, namespace handling, class styling, members + notes, relationships, generators, test suites, layout.
  4. Validate by running the diagram target — see How do I generate PlantUML diagrams?. Fix any PlantUML syntax errors.
  5. Self-check against the evaluation checklist in the conventions doc (no class-to-namespace arrows, stereotype order, consistent colours, syntax valid).

Recipes

Reference

Emacs 29.1 (Org mode 9.6.6)