search

TriciaBK / pe

0 stars 0 forks source link

Lacks sequence diagram #15

Open TriciaBK opened 10 months ago

TriciaBK commented 10 months ago

There seems to be no sequence diagram available in the Developer Guide. Sequence diagrams are important for readers to understand how the methods in the program and the difference classes work.

soc-pe-bot commented 10 months ago

Team's Response

Thanks for your comment. We should have added more sequence diagram into the DG.

The 'Original' Bug

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

DG diagrams seem lacking

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.

Some other type of diagram used when a UML diagram would have worked just as well.

4 diagrams given, 3 of which are similiar. None shows the proper sequence and flow of the functions.

[original: nus-cs2113-AY2324S1/pe-interim#803] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

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

Thanks for your comment. We should have added more diagram.

I have changed the servity to low, as in rare cases readers may get confused with the design of program without the aid of diagrams.

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`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]