nus-pe-bot
commented
2 years ago Team's Response
Reasons for rejecting:
-
Firstly, this seems like a suggestion rather than a bug, and so should be rejected (see screenshot below). This report is merely a suggestion because there is no explicit requirement to have a command summary in the User Guide.
-
Secondly, we have a Table of Contents that serves like a command summary for the user to refer to if they forget the command.
Reasons for changing severity from High to Low:
- Lastly, even if this is considered a bug, it should not be a High severity issue because it does not cause "major problems" for the user. It also does not make the User Guide or the product "almost unusable" for the user, because the user can always refer to the Table of Contents.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: Consider the following user story: "As a forgetful user, I would like to be able to refer to the command format in the user guide easily, so that I can type it out faster without having to search for the commands one by one."
A reminder that this is a CLI app, where typing out a command only allows you to execute a particular action. Your ToC only covers the general command that you should be typing out. It does not include the comprehensive format of the command (e.g. add d/DESCRIPTION goal/GOAL [bydate/END_DATE] [bytime/END_TIME] for add command), whereby user should navigate through the UG one by one just to follow the formatting that you have provided. Users can easily forget the parameters that exist, especially considering the command format is diverse for each command. I will insist this as a bug instead of a suggestion as it does not cover the user story above, and users would have difficulty of navigating through the table of contents just to find out what the formatting is.
While I do think that this could only happen in some cases (where the severity should be low instead of high), having a command summary for the users to refer to will be convenient for both the users and the developers as they can directly refer to the command format given in the command summary without having to navigate through the table of contents to remember each command.
:question: Issue severity
Team chose [severity.Low]
Originally [severity.High]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
There is no command summary for an experienced user to view the commands they might have forgotten. This is clearly a high severity documentation bug, as we did not have anything to refer to during typing the commands.