search

nus-cs2113-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Object relations are not sufficiently clarified in DG for some functionalities #764

Open nus-pe-bot opened 18 hours ago

nus-pe-bot commented 18 hours ago

image.png

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)

image.png

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

kaboomzxc commented 1 hour ago

Team's Response

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

We feel that the diagrams are clear, but we also feel that there is room for improvement.

Duplicate status (if any):

--