search

chihyingho / pe

0 stars 0 forks source link

DG Command Sequence Diagrams Lack Description #16

Open chihyingho opened 2 years ago

chihyingho commented 2 years ago

The sequence diagrams representing each command have no explanation or further description.

nus-se-script commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

The Command Sequence diagram in DG lacks explanation

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

The Command Sequence diagram in DG lacks explanation, which could be a little confusing, may suggest to add a few description of the processes?

[original: nus-cs2113-AY2122S2/pe-interim#1025] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Thank you for your suggestion.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

:question: Issue severity

Team chose [severity.Low] Originally [severity.Medium]

Reason for disagreement: I believe that the bug deserves more than a severity low as it prevents users from fully understanding how each command functions. The description of each command sequence diagram is important in order to emphasize important steps in the command sequence. This is important especially because certain sequence diagrams are rather huge. Descriptions are also important in order to provide further explanation on the functions, since sequence diagrams cannot offer further detail. This would cause significant inconvenience to readers.