ltzehan / pe

0 stars 0 forks source link

Lengthy sequence diagrams are difficult to follow #16

Open ltzehan opened 1 year ago

ltzehan commented 1 year ago

Sequence diagrams are very long and span multiple pages. Consider using reference frames, or breaking a single sequence diagram up into multiple parts for clarity:

image.png

For example, the above diagram can be split into several parts:

nus-pe-bot commented 1 year ago

Team's Response

Accepted with lower severity. We agree that the sequence diagram could have been broken down further to improve clarity and this will be done in future updates to the DG. However the readability issue was also due to the issue of formatting (landscape) which mixed up the words and the diagrams (duplicate of bug 2867) and hence the severity for this bug has been lowered.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]