search

nus-cs2103-AY2021S1 / pe-dev-response

0 stars 0 forks source link

Disjointed architecture diagram. #827

Open nus-se-bot opened 3 years ago

nus-se-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.

Issue description:

In page 4 of the DG, the arrows pointing to commons are not connected to anything.

Additional details/ screenshot:

Screenshot 2020-11-13 at 1.35.04 PM.png

[original: nus-cs2103-AY2021S1/pe-interim#743]

Marcon2509 commented 3 years ago

Team's Response

image.png

It is already stated that commons represents a collection of classes used by multiple other components so all other classes refer to commons. Furthermore Architecture diagrams do not have standard notations and is fine to represent commons being used by multiple classes in this manner rather than have all the classes point at commons which would ruin the aesthetics of the diagram by making it more messy for the user which would hinder the user ability to understand the diagram. Also the severity of the issue should be very low as it is a cosmetic change that does not hinder the user's ability to understand the diagram.

image.png

Also, the AB4 developer guide aslo contains this type of representation so we feel the implementation in our diagram is also valid

Duplicate status (if any):

--