search

Jillzyt / pe

0 stars 0 forks source link

[UG] Command summary does not provide all examples #13

Open Jillzyt opened 3 years ago

Jillzyt commented 3 years ago

Some parameters are optional. It will be nice to have all examples of the commands including and excluding optional parameters.

nus-se-bot commented 3 years ago

Team's Response

There are numerous reports that are largely similar and these issues can be identified as subsets of this bug report.

A User Guide is meant to give users a quick taste of the app by guiding them through usage of our commands. The format of each command (including usage of optional parameters) has been written in the UG.

image.png

By providing representative examples for actual usage, users can then be more confident in exploring the application for their own use cases. There is very little added benefit and it would not be feasible to include all permutations of examples (especially for different variations of valid input and also optional fields) as it may appear spammy instead. Our approach is to be clear and consise by including an expected outcome for representative examples.

Instead of providing all permutations, we explained under format what are the possible use cases and we believe the examples in User Guides are not meant to be exhaustive.

image.png

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Understand the consensus of the team. However, the users may not remember the entire user guide from the start. They may only refer to the command summary on how to use them. Hence, it will benefit greatly. Given that there's only one optional parameter, it may not be spammy at all to even include one additional line for the optional parameter example.