swtan346 / pe

0 stars 0 forks source link

Insufficient details for Implementation of Appointments #16

Open swtan346 opened 3 months ago

swtan346 commented 3 months ago

It would be good to add how the component reacts with each other and the methods involve

nus-pe-script commented 3 months ago

Team's Response

Thank you for reporting. However, we have to choose it as NotInScope because this issue doesn't affect the current usage of the product and is not actually a flaw. First, we are instructed that putting significant features that need more elaboration into the DG's implementation detail section is enough. However, the implementation details for Appointment Management are very simple. It is not a significant feature that needs to be documented in very much detail. Elaborating more on this (as well as other very similar features such as patient management and contact management) would make the DG extremely long. The reality is, some people might prefer concise and simple explanations, while others might prefer the opposite. It is very hard to satisfy all reader's tastes. We might want to consider adding more implementation details for this feature in the DG in future iterations, but providing the work we have already done, the proposed issue is not in the scope.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: The current documentation for appointments solely outlines their functionality and usage, which may seem redundant as these aspects are apparent when exploring the application. Instead, the DG should delve into the underlying mechanisms and illustrate the interactions between entities.