nus-pe-bot
commented
3 years ago Team's Response
Similar to AB3, we included a quick start section that covers all of the commands. This section is meant to provide users with an overview for all the commands without having to read their respective sections in depth.
In addition, since this is the quick start section, users can easily refer to the respective section should they wish to find out more in depth about a particular feature.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: I feel that if the quick start section intends to include all possible commands, it would be prudent to ensure that all the commands would return a result that a user can tangibly see. As for now, since the update command comes quite late, the warehouse added in the first add example would not have any products (e.g. Panadol). This would make it somewhat more difficult for a new user to see if the find command had worked, as it would return an empty list of warehouses. While it is not unexpected behaviour, I just feel that a new user's user experience could be improved with a simple change in the order in which the commands are listed.
:question: Issue severity
Team chose [severity.VeryLow]
Originally [severity.Medium]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
The list of sample commands given in step 5 of the Quick Start section feels too long to read through, and detracts users from referring to the more detailed explanations further down in the UG. I did not test it, but the given sample
findmight not actually show any results depending on the initial sample data. If the command is to be left in the Quick Start section, it might be better to move theupdateexample before it, so that when new users perform thefindcommand, they can see that it really works.