search

nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Visuals in DG not well integrated #1331

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.

Plenty of UML diagrams were drawn which is very good for understanding the application. However, the diagrams were no tied to the explanations for the respective commands, breaking up the flow of the DG. This is referring to the diagrams at the command section. The section includes only the diagram and nothing to explain or describe the functions.

[original: nus-cs2113-AY2021S2/pe-interim#1331] [original labels: severity.Medium type.DocumentationBug]

jadenwjh commented 3 years ago

Team's Response

Noted. It was an assumption that with a clear diagram, one will understand how the component works. Hence, to reduce word count, we removed most of the details. However, since this is brought up, we will still take this as a valid response.

Duplicate status (if any):

--