nus-pe-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. The provided text explanations are already very clear and concise about how the features are implemented. Diagrams should only be used when there is a need to demonstrate more or if it is better at illustrating an idea. However, in our case, we find that text explanation is already a very effective way of illustrating all the implementation details. Therefore, we suggested that diagrams are not an urgent thing to be added compared to what we have already done.
Items for the Tester to Verify
:question: Issue response
Team chose [response.NotInScope]
- [x] I disagree
Reason for disagreement: In the current DG, the team only provided the high level view of the implementation. For example, the readers do not know how the objects interact to create an appointment. However, by using a sequence diagram, it provides a visual representation of the interactions between objects. This visual representation is easier to understand and digest than a textual description. Without the diagram, readers may struggle to grasp the sequence of events and the relationships between objects.
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
The implementation is too wordy and do not have diagrams to support which makes it hard to read and understand. It will be good to add more diagram, e.g. activity diagram, sequence diagram.