Hazel1603 / pe

0 stars 0 forks source link

Examples #20

Open Hazel1603 opened 3 years ago

Hazel1603 commented 3 years ago

Examples tend to be very short and not enough description for the examples. Might be a good idea to give wrong cases.

nus-se-bot commented 3 years ago

Team's Response

We gave both a generalised format and a example to show how the generalised form is used. To show different wrong commands is not conducive to show the user how to correctly use the command. This is a really vague issue.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: For example, in this screenshot below, there is description of the expected outcome of the command. Screenshot 2020-11-18 at 11.05.59 PM.png

However, this was not consistent and elaboration was omitted in the second half of the UG. This affects the understanding of the command. Screenshot 2020-11-18 at 11.07.14 PM.png

Showing wrong commands can give users a better understanding of how the parsing of inputs work, without giving away too mcuh information and guide them on how to better use the product.


:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Medium]

Reason for disagreement: [replace this with your explanation]