search

Jillzyt / pe

0 stars 0 forks source link

[UG][Add Warehouse Command] Phone number example can be improved #17

Open Jillzyt opened 3 years ago

Jillzyt commented 3 years ago

Similar to #15

Better phone number examples.

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: As the team mentioned, they try to explain under format what are the possible use cases. Having 00000000 as a phone number is a possible use case but not an appropiate use case to be used as it is not applicable in real life (It is highly unlikely the medical suppliers managers will use invalid phone numbers). Furthermore, 00000000 may be hard to type as they are all same digits (hard to try out in the application at the start).

The 98761234 example is good.