nus-cs2103-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Lack of standardisation of diagrams in DG #2066

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year 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.


Lack of standardisation of diagrams in DG

Some UML diagrams in your DG have enclosing boxes, some do not.

Examples

Example with enclosing box:

Screenshot 2022-11-11 at 5.24.25 PM.png

Example without enclosing box:

Screenshot 2022-11-11 at 5.24.14 PM.png


[original: nus-cs2103-AY2223S1/pe-interim#1738] [original labels: severity.VeryLow type.DocumentationBug]

kelvinou01 commented 1 year ago

Team's Response

In the first diagram, the box serves to compartmentalize the components under the Model logical unit. There is no such need for compartmentalization in the second diagram.

Duplicate status (if any):

--