Doc Add ER Diagram
Table of Contents
When to use this skill
When the SQL schema gains tables or relationships and the ER
diagram at projects/ores.sql/modeling/ores_schema.puml needs to
catch up, or when documenting newly-added tables.
How to use this skill
- Identify the tables. Read
projects/ores.sql/create/*_create.sqlto enumerate every table, its columns, primary key, foreign keys, and indexes. - Group entities into domain packages — IAM, RBAC, Assets, Variability, etc. The package colour palette is in the conventions doc.
- Author the diagram following the conventions in PlantUML ER
diagram conventions — skeleton, entity styling
(
<<temporal>>/<<junction>>/ none), field notation, relationships, notes, temporal columns. Validate via How do I generate PlantUML diagrams?:
cmake --build --target generate_ores_schema_diagram
- Self-check against the evaluation checklist in the
conventions doc (every table represented, FK arrows match the
SQL
REFERENCES, stereotypes correct, packages logical, syntax valid).
Recipes
- How do I generate PlantUML diagrams? — build / preview loop.
Reference
- PlantUML ER diagram conventions — styling and the evaluation checklist.
- ores.sql — the component whose schema this diagram documents.
- plantuml-class-modeler — sibling skill for class diagrams.