shawnpong / pe

0 stars 0 forks source link

Complicated sequence diagram #13

Open shawnpong opened 2 months ago

shawnpong commented 2 months ago

image.png This diagram might have been too complicated and defeats its purpose of allowing developers to understand the general idea of what the list sales by day function command is doing. This sequence diagram is one entire page big/long.

A large diagram such as this might hinder the readability of the user. As stated in the textbook, you can use ref to break sequence diagrams into multiple diagrams. image.png

image.png

soc-pe-bot commented 2 months ago

Team's Response

Indeed, some of the sequence diagrams are too long and can be truncated.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: A sequence diagram being too comlicated(an entire page long) can be considered to hinder the readability of the diagram, hence the readers understanding of the application/app design. This is not a cosmetic bug as indicated but a serverity.verylow. This in fact can and should have been labelled as a severyti.medium as it serves little purpose to educate the reader, as much as it made the documentation unruly and illegible(it is very small, i had to zoom to 200% to view it adequately).