search

liping-eng / pe

0 stars 0 forks source link

Lack of visuals and examples. #15

Open liping-eng opened 3 years ago

liping-eng commented 3 years ago

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.

nus-pe-bot 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.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Low] Originally [severity.High]

Reason for disagreement: [replace this with your explanation]