nus-pe-bot
commented
4 years ago Team's Response
Example commands and explanations are already provided to the user when they enter invalid input for individual commands.
Help window are targeted for new users to refer to commands that the app offers.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: Firstly, I am describing the 'help' command's feature, not the entire application. It is unwise to assume the user would enter the correct command words which will prompt the corresponding command's error message to show them how to use the command.
Moreover, help should not be displaying the entire User Guide (24 pages). We cannot expect the readers to simply view the entire User Guide, or at least a need to navigate to that part properly without using a mouse. Scrolling with the up/down commands take too long, and the fastest way is to use a mouse. Even with a mouse, the 24 page user guide may require much scrolling. Evidently, this is downplays the component of being CLI-based.
Instead, what the team should do instead is to come up with a help window that can allow users to find whatever help they need in one glance conveniently. They lack this convenience and therefore it is a feature flaw, not only because it is not so much CLI based, but also that it brings inconvenience to the user instead. Users will VERY LIKELY need to use the 'help' command, because this application has many commands that can be confusing for new users. In other words, they also lack convenience in the 'help' command, where it is most needed.
Moreover, users would be discouraged from viewing the 'help' window once seeing how long the user guide is (based on the size of the scrollbar). We should also not simply paste the entire User Guide into the help window, but rather - like described before - show some effort in coming up with a summarised version of the commands and their purpose.
Therefore, as this 'help' does not conform closely to being CLI-based, and that it brings about inconvenience for the users, I have marked this as feature flaw bug. Moreover, based on the below guideline for the PE:
Marking this as medium severity is suitable.
As seen below, when we use the help command, it opens a window that requires scrolling. Would be more optimised for CLI-based users if you could access individual commands/features via help command directly as part of the parameters.