Chapter 3 · Practice 2 of 3
Use diagrams that match the system you actually built
Why it matters
Design chapters usually include some of: an architecture diagram, use case diagram, class or component diagram, entity relationship diagram, sequence diagrams for key flows and screen flows.
Rules that keep them useful:
- Match the code: if the database has eight tables, the ERD shows eight tables with the same names. Examiners notice mismatches, especially when they ask you to open the code.
- One idea per diagram: an architecture diagram with every class on it helps nobody.
- Draw them yourself: use a tool such as draw.io or PlantUML, and keep the source files in your repository so you can update them.
- Explain each one: two or three sentences in the text saying what the reader should notice.
If the design changed during the year, update the diagrams and mention the change; do not leave the proposal-stage design in the final report.
Do
- Keep diagram source files in the repository
- Update diagrams whenever the design changes
Avoid
- Diagrams copied from the internet or from another project
- An ERD that does not match the real database