WilsonLee2000 / pe

0 stars 0 forks source link

Insufficient examples of sample outputs in User Guide #17

Open WilsonLee2000 opened 1 year ago

WilsonLee2000 commented 1 year ago

Hi Team, there are insufficient sample outputs in the User Guide, causing users like me not to understand what we should be expecting if we have keyed in the command correctly.

image.png

nus-pe-bot commented 1 year ago

Team's Response

Understand that there could have been more examples given, we do believe that there is no problem for users to understand it as the examples we have given already covered all the possible variations of the input formats. Anyways, thanks for pointing this out!

Items for the Tester to Verify

:question: Issue response

Team chose [response.CannotReproduce]

Reason for disagreement: I'm not sure why did the team chose response.CannotReproduce. According to the CS2113 Website: "response.CannotReproduce: You are unable to reproduce the behavior reported in the bug after multiple tries."

The team has also acknowledged by replying "Understand that there could have been more examples given".

Nevertheless, I felt that the team is not understanding what I'm trying to put forth as they talked about covering all possible variations of input format.

What I meant was though it is commendable that the team have decided to include some Example of usage (the inputs) in the User Guide, the team did not include any "Expected Output` sections in the User Guide", hence causing readers like me not to understand what we should be expecting from the output if we have keyed in the command correctly.


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** I maintain at severity.Medium because as a reader and user myself during the PE, with the lack of expected output provided in the UG, accompanied with certain ambiguous and unclear phrasing of the User Guide, I was at a complete state of loss during the PE trying to figure out whether I have keyed in the correct command inputs.