[PE-D][Tester C] Bug Report: UML Diagrams in Developer Guide Are Still From Original Template (Not Updated for TeamScape)

[nus-se-script]

Issue Bug:
UML diagrams in Developer Guide (e.g., Sequence Diagram for delete) are still referencing AddressBook and do not reflect TeamScape's custom implementation

Environment:
Documentation: Developer Guide

Section: Architecture → "How the architecture components interact with each other"

Screenshot example shows use of deletePerson(p) and saveAddressBook(...) — clearly not updated from AB3

Steps to Reproduce:

Open the Developer Guide.

Navigate to sections containing UML (e.g., Sequence, Class Diagrams).

Observe components like saveAddressBook, deletePerson, and AddressBook which are from the base project (AB3).

Expected Behavior:

Diagrams should reflect TeamScape’s current class names, method calls, and component interactions.

All references to AddressBook should be replaced (e.g., with TeamScapeData, deleteTeamMember, etc. if renamed).

Actual Behavior:

Diagrams still use AB3 classes and interactions.

Misrepresents how the actual architecture of TeamScape works.

Impact:
Misleads contributors or graders evaluating code design

Suggests lack of customization and effort

Lowers professionalism of the Developer Guide

Suggested Fix:

Redraw all UML diagrams to reflect TeamScape’s implementation

Tools like PlantUML or IntelliJ’s UML generator can help recreate accurate versions

---

Labels: type.DocumentationBug severity.Medium
original: Liu-Jihan/ped#9

[awc1116]

I believe that we did not change the internal method names so the diagram is still using saveAddressBook() as the naming for the method call.