Object relations are not sufficiently clarified in DG for some functionalities

[nus-pe-bot]

While some functionality descriptions explain object relationships sufficently, some, such as the "Managing Patients and Records" section, have overly brief explainations of object relationships, and do not clarify the excess objects included in diagrams, either through association labels, or otherwise (i.e. footnote).

Examples include omitting significant details, such as which objects/classes are interacted with to call certain methods/create new objects. This makes it difficult to understand the role that these classes/objects have in the overall architecture, therefore making maintainance more difficult.

(For example, it is entirely ommitted how appointmentRecords are relevant to adding visits functionality)

---

_{[original: nus-cs2113-AY2425S1/pe-interim#756] [original labels: severity.Low type.DocumentationBug]}

[kaboomzxc]

Team's Response

Hi Tester,
Thank you for your Description of Issue and Feedback.

We feel that the descriptions and diagrams are clear in explaining the object relationships, but we also acknowledge that there is room for improvement in future iterations.

The tester commented: "For example, it is entirely ommitted how appointmentRecords are relevant to adding visits functionality"
To clarify, in BookBob, the adding visits functionality is classified under patient records which is entirely separate from appointment records.

Duplicate status (if any):

--