Sequence Diagram is Invalid in terms of the parse(), parseCommand() and execute()

[KhoonSun47]

Steps to reproduce:

• Currently, the execute(), parseCommand() and execute() in the sequence diagram under Logic Component does not have a parameter.
• However, if you were to follow the sequence diagram that is under Edit Applicant Feature, there are parameters for parse(), parseCommand() and execute()
• This results in inconsistency in the sequence diagram that may confuse the user.

Logic Component Sequence Diagram:

Edit Applicant Feature Sequence Diagram:

Suggestion: I believe that you can make the sequence diagram more consistent by making sure there are parameters within the methods.

[nus-pe-script]

Team's Response

The reported issue does not affect the quality of the documentation as the first diagram is intended for high level view for logic component and second diagram is for explaining in detail for editting applicants. Hence, it is rejected. Thanks!

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

• [x] I disagree

Reason for disagreement: I disagree that this issue should be categorised as "response.Rejected" and it should be remained as “response.Accepted” instead. 


While your team response clarifies that the first diagram under "Logic Component" is designed to provide a high-level overview, it does not address the omission of parameters for the execute(), parseCommand(), and parse() methods. 


According to the textbook, if the parameters are irrelevant to the sequence diagram's intent, they should be omitted using ellipses ("...") rather than left blank. 


This inconsistency could cause confusion, especially since the second diagram, which is intended to detail these methods, includes parameters. 


Readers might question whether these are different methods or whether parameters should be included at all.

This clarification is crucial for ensuring accurate understanding and consistency throughout the Developer Guide.



---