cbj252 / pe

0 stars 0 forks source link

UML diagram and it's heading separated #15

Open cbj252 opened 10 months ago

cbj252 commented 10 months ago

The UML diagram for find_event is on a different page, and somewhat far from the heading that describes what it is. This forces the user to slow down and flip between pages to know what the UML diagram is referring to, hindering them.

image.png

soc-pe-bot commented 10 months ago

Team's Response

This issue can be resolved by adjusting the zoom rate for a better view, without having to flip between pages. From your image provided, FindEventCommandParser is visible from the sequence diagram, which indicates that the sequence diagram is for the find_event command.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The team says that the issue can be "resolved by adjusting the zoom rate for a better view": but this is the same justification given in the textbook for small UML details: "While the reader can zoom to see smaller details, this can still be considered a cosmetic issue (i.e., severity.VeryLow)." Therefore, according to the textbook, problems that can be resolved via zoom can still be considered as a cosmetic issue. Therefore, this issue should also be considered as a cosmetic issue.

The solution given by the team also does not account for users who do not have infinite scroll pdf readers, where it would be impossible to see both the heading and the diagram at the same time because the reader can only show one complete page at a time.

Looking at the pdf as a whole, almost all other diagrams are on the same page as and next to their headings, except this one. This is a layout/formatting issue with the potential to hinder the reader.