search

Aseanseen / pe

0 stars 0 forks source link

Sequence diagram too complicated and too small to read #11

Open Aseanseen opened 3 years ago

Aseanseen commented 3 years ago

This diagram can be split into 2 smaller diagrams. Additionally, the words are very small in the DG, making it hard to read.

image.png

nus-pe-bot commented 3 years ago

Team's Response

It will be very misleading if we split the diagram into two, as it shows one function printTimelineCommand. You can use zoom in to view the diagram if the words are small.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The purpose of a diagram in the DG is to provide clarity.

If the developer is unable to follow with the diagram due to its inexcessive complicatedness, then the diagram does more harm than good.

As stated by Prof, the diagrams are meant to focus on comprehensibility rather than comprehensiveness.

image.png

image.png

:question: Issue severity

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

Reason for disagreement: Very low is only for cosmetic reasons such as typos. The diagram being too complicated will confuse the developer reading it and hence, should be awarded a severity.Low at the minimum.

image.png