search

nus-cs2113-AY2122S1 / pe-dev-response

0 stars 0 forks source link

DG lacks visuals and is very wordy from page 14 to 28 #2936

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.

The Developer guide is super wordy and lacks visuals from page 14-28. This makes it very boring for the reader to develop interest in actually reading it.

[original: nus-cs2113-AY2122S1/pe-interim#2909] [original labels: severity.Low type.DocumentationBug]

titustortoiseturtle1999 commented 2 years ago

Team's Response

Page 14 - 15 contains the parser implementation, which has a diagram on page 13. Page 16 onwards contains user stories, glossary, manual testing and other sections which are explained clearly without diagrams.

Duplicate status (if any):

--