search

nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Architecure diagram bugs in DG #5656

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 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.

image.png

These are just a few examples among many which have stray arrows at the top. Not sure of their significance. There is also significant overlap in the labels, titles within the diagrams.

[original: nus-cs2103-AY2122S1/pe-interim#5682] [original labels: severity.High type.DocumentationBug]

Zzhiwei commented 2 years ago

Team's Response

"Stray arrows"

The arrows are from the previous diagram which we included below for convenience.

Screenshot 2021-11-13 at 11.04.57 PM.png

These two diagrams are an abstracted out diagrams for the Students and TuitionClass boxes, showing the lower level details, so that the overall model diagram would not be too cluttered.

"Significant overlap"

Assuming the overlaps you are referring to are the all and filtered labels on the arrows, the overlap is very minimal and insignificant, and does not affect readability. It is also a limitation of the plant UML diagram. Furthermore, it is only a cosmetic issue and in the worst scenario, a VeryLow, not High.

Duplicate status (if any):

--