search

nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

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

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

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.?

[original: nus-cs2113-AY2021S2/pe-interim#1146] [original labels: severity.Medium type.DocumentationBug]

ongweisheng 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.

Duplicate status (if any):

--