swtan346 / pe

0 stars 0 forks source link

No implementation details for Contact Management #14

Open swtan346 opened 3 months ago

swtan346 commented 3 months ago

It would be good to add the implementation details for the feature for Contact Management.

nus-se-bot 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 needs more elaboration into the DG's implementation detail section is enough. However, the implementation details for Contact Management is 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 medical management) would make the DG becomes 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 taste. 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: Contact management constitutes a significant aspect of VitalConnect, supported by numerous features. Therefore, it's not accurate to deem the implementation trivial. Furthermore, the team could have provided an overview of each feature, allowing readers to skip details if they feel that the overview is sufficient. Hence, omitting the implementation of contact management entirely may not be justified.


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** Implementation details are crucial components of a developer guide. However, in the current developer guide, readers are not even aware that the contact management features have been implemented.