nus-pe-bot
commented
3 years ago Team's Response
The activity diagram is to show the sequence of steps executed in the command, it is to show how the patient index provided by the user is eventually parsed as patient in the patient list. Omitting the details will render this diagram useless to the reader.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: Thank you for the response. I think these steps would be better represented in a Sequence diagram because:
- Purpose of activity diagrams are to illustrate workflows (refer to https://nus-cs2103-ay2021s1.github.io/website/schedule/week9/topics.html#w9-2-activity-diagrams).
Hence, it should only contain higher-level details such as:
User enters input -> If input is valid : A valid appointment is added -> Success message displayed to user -> end.
-> else : Error message displayed to user -> end.
Lower level details such as classes and methods will make the workflow less obvious.
- Given that this diagram wants to show a sequence of method calls executed when user input is received, it essentially tries to show how objects interact with each other (specificly, AppointmentScheduleCommandParser, AppointmentScheduleCommand and so on) rather than workflow for the user (what the user should see, what should happen etc...). For this purpose, a sequence diagram would make this clearer (refer to https://nus-cs2103-ay2021s1.github.io/website/schedule/week6/topics.html#w6-1-modeling-sequence-diagrams). Using a sequence diagram would be clearer because it represents the interaction in a more visual format, which object calls / create which object etc... instead of just text format in activity diagram.
Activity Diagram under Schedule Appointment goes into too much low-level details. This might be better captured in a Sequence Diagram instead.