dhanish265 / pe

0 stars 0 forks source link

Sequence Diagrams are too big in general #12

Open dhanish265 opened 1 year ago

dhanish265 commented 1 year ago

image.png

Should be ideally broken up into diagrams, or more details should be omitted for increased clarity

image.png

This one exceeds 1 page. That is far too long.

image.png

This one is highly nested and impedes readability.

nus-pe-bot commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Very large sequence diagram in DG, pg 13-15

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.


image.png

This sequence diagram, may have been broken up into the alt pathways separately, as the clarity is slightly compromised by the formatting issues and high density due to size of the diagram.


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

Their Response to the 'Original' Bug

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

No details provided by team.

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 disagree as the size of the diagram and the resulting lack of clarity makes it really hard to understand what is going on.