search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

UI UML diagram in DG is too cluttered #667

Open nus-pe-bot opened 6 months ago

nus-pe-bot commented 6 months 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.

The UI UML diagram in the DG is too cluttered; I had to zoom in 5 times before I can see the contents clearly (on Microsoft Edge). It might be better to increase the size of the image or to separate some parts into another diagram.

image.png

[original: nus-cs2103-AY2324S2/pe-interim#525] [original labels: severity.Low type.DocumentationBug]

nigel27022001 commented 6 months ago

Team's Response

With reference to the CS2103/T Website: Details in the diagram too small: This is usually a symptom of having too much info in the diagram. A common example is sequence diagrams showing low-level details of multiple components (recommended: A sequence diagram should show internal interactions of at most one component i.e., treat other components as black boxes). While the reader can zoom to see smaller details, this can still be considered a cosmetic issue (i.e., severity.VeryLow).

This flaw is purely cosmetic as it has to do with the layout and spacing issues in the docs. we changed it from low to very low as the diagram is purely to give a bird's eye view of the UI Components. On top of that, we included text below the diagram to elaborate more on the diagram. Additionally, on my screen, I can see all of the diagram components clearly. The reason why the assessor had to zoom in was because our developer guide is in portrait, while our monitors are in landscape form.

Duplicate status (if any):

--