nus-cs2113-AY2021S1 / pe-dev-response

0 stars 0 forks source link

DG visuals are generally not well itegrated with the explanations #208

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.


The team uses alot of diagrams to aid in clarity of explanation. However, many of these are unnecessarily complicated and lack accompanying explanations. Examples include DG sections 4.1 and 4.2.


[original: nus-cs2113-AY2021S1/pe-interim#196]

nat-ho commented 3 years ago

Team's Response

1 - Our diagrams have been simplified to ensure that there is minimal repetition of classes (eg. Diagrams in section 4.1 and 4.2 did not include class level member entities) 2 - Similar to AB3, our explanations are included for areas where it is hard to understand. Thus for simple class diagrams, we decided not to include lengthy explanations.

Duplicate status (if any):

--