search

hazelhedmine / pe

0 stars 0 forks source link

Colors used for diagrams in the developer guide is not consistent, hence can be confusing. #19

Open hazelhedmine opened 3 years ago

hazelhedmine commented 3 years ago

There is no explanations on the meaning of the colors, and they are not consistent across diagrams hence can be confusing for the reader.

For example:

image.png

image.png

image.png

Perhaps parser classes could be the same color and Ui could be the same color etc.?

nus-pe-bot commented 3 years ago

Team's Response

Different software used by different developers due to compatibility issues. Different colours used are just to differentiate between objects and classes in the sequence diagram, not to ensure that 1 class or object has to be a specific colour.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: As stated by the team's response, different colors were used to differentiate between objects and classes in the sequence diagram, not to ensure that 1 class or object has to be a specific color. However, in the first screenshot, all of them were in yellow which does not help to differentiate the classes or objects. Additionally, this was not specified in the developer guide.

Readers may get confused on the meaning of colors as normally color coding is used to organize information, hence it would make the diagrams more understandable if it was made clear to the user that the colors were simply meant to differentiate the different classes.

:question: Issue severity

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

Reason for disagreement: I believe the severity level should be low since it hinders the usability of the developer guide.