search

GeNiaaz / pe

0 stars 0 forks source link

Unnecessary second diagram (DG) #20

Open GeNiaaz opened 3 years ago

GeNiaaz commented 3 years ago

Second diagram provided is similar to the first one offering minimal changes, and is not necessary to show to the devloper.

Instead, it makes the guide more cluttered and harder to interpret

image.png

nus-se-bot commented 3 years ago

Team's Response

Although the diagrams are similar, they are necessary. This is because the mechnism for processing these two commands can be very different and showing these two sequence diagrams is intended to show the similarity of how VirusTracker process these two different commands as well as to show the minor difference between these two command.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: While the mechanisms are indeed different, I fail to see how the different mechanism is conveyed in the 2 diagrams. The initial command is different yes, but i fail to see any notable differences in the subsequent portion of the second diagram, and it seems unnecessary and indeed simply adds to the clutter.

:question: Issue severity

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

Reason for disagreement: This is just one diagram, yes. However, when this programme is expanded, or more functions are added, unnecessary diagrams like this can add up and with a longer Developer Guide, this could snowball and make it very cluttered and littered with unnecessary diagrams.

For these reasons, I believe this is not a veryLow severity, and is something that deserves attention at this early stage in the program's development.