search

nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Lack of visuals and examples. #1198

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 user guide is not comprehensive enough and there is a general lack of visuals and examples.

Could have place in 1 or 2 code snippets for each example for the user to know his expected output.

image.png

^2 page long UG.

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

tehtea commented 3 years ago

Team's Response

  1. Expected output is already provided, even based on the screenshot attached alone.
  2. More examples, however, and maybe some kind of an end-to-end example will be helpful so yes that will be added.
  3. Severity is unlikely to be high, as that will mean the tester will be unable to test the product at all.

Duplicate status (if any):

--