dillontkh / pe

0 stars 0 forks source link

Unecessary (repeated) details in activity diagram #20

Open dillontkh opened 2 months ago

dillontkh commented 2 months ago

image.png

image.png

As seen from the screenshots above, there is quite a lot of overlap between the activity diagrams of the add event and edit event command. Maybe the common parts could be extracted out to a separate diagram to improve readability?

nus-se-script commented 2 months ago

Team's Response

Hi, thanks for the suggestion, however we believe that separating the overlapping portions would actually hinder readability more, as the reader will have to refer to 2 diagrams for a single command (thus, having to scroll up and down repeatedly), making it more confusing as well.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: My issue with the diagrams is that the team had included a lot of extra details such as the parsing of the command.

image.png

image.png

For example, the screenshots above from the same diagram are just for parsing the command, while the details specific to the command are only a small portion of it as shown below.

image.png

image.png

Since the parsing of the command is common to many features, I thought it would have been more prudent for it to have its own activity diagram.

Including these unnecessary details distracts the reader from understanding what the UML diagram is supposed to illustrate.


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** ![image.png](https://raw.githubusercontent.com/dillontkh/pe/main/files/3152edca-f6b4-4e6e-a189-554c4ee3e962.png) Including unnecessary details in activity diagrams would not hinder the reader from ultimately understanding the diagram, however, it **_would_** inconvenience the developer, who has to sift through more information. ![image.png](https://raw.githubusercontent.com/dillontkh/pe/main/files/5eba4a4d-e17d-41da-a9c2-c8aa8e3d27a3.png) I disagree that it the problem is purely cosmetic, as the main issue is that the diagram contains more details than necessary.