nus-pe-bot
commented
9 months ago Team's Response
We focused on showing positive examples by displaying a screenshot for valid commands.
For invalid inputs or examples, we have already included a “Potential Errors” table for the possible error messages that can be shown and the corresponding resolutions. In this table, we already mentioned the valid ranges of inputs, and hence believe that invalid inputs are an obvious inference.
While detailed information on invalid inputs might be valuable for developers or technical documentation, the user guide prioritizes practical guidance for users seeking to accomplish tasks effectively. Including more examples for invalid inputs and the consequent error messages will be excessive and may cause confusion to the user.
Furthermore, with feedback from our tutor from CS2101, it was better to standardise with 1 positive example rather than to come up with multiple negative examples as that could be distracting for first time users who are also viewing the UG for the first time.
We believe that emphasizing correct usage and providing solutions to potential errors aligns more closely with users' needs and the intended purpose of the user guide.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
I like how there are examples for every command and its usage, however it would also help to have some invalid inputs (alongside the restrictions that were mentioned for some parameters).