nus-pe-script
commented
1 year ago Team's Response
No details provided by team.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
UG not well-formatted
Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.
After the start command in the UG, it proceeds to explain achievements, clear_achievements and ippt before explaining the commands within the workout session. Given that the 3 commands listed above cannot be called before the existing exercise is completed, it can cause confusion for readers who are unable to run the 3 commands.
[original: nus-cs2113-AY2223S2/pe-interim#449] [original labels: severity.Low type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
The reason for putting the achievements and clear_achievements right after the start command is because understanding how those functions work is necessary in order to fully understand the output shown upon the completion of an existing exercise. Hence we hope to be able to push this to severity very low.
Items for the Tester to Verify
:question: Issue duplicate status
Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** VeryLow severity is reserved for cosmetic flaws which do not affect usage. From the responses of the other tester and myself, this bug has clearly affected our usage of the program when we were confused about why the "achievements", "clear_achievements" and "ippt" commands were not working after the "start" command. Apart from this, I believe that many first-time users would experience this confusion on their first time using the program. This means that many users will experience a minor incovenience. Hence, I beieve that this confusion will cause usage problems for some users and it is a Low severity flaw like what the other tester called it. Initially, I overestimated the severity as Medium but would like to correct it to a Low severity flaw. However, I believe that it is still definitely not a VeryLow severity flaw as the flaw affects usage and is not purely cosmetic.
In the user guide there is the start command and how it works. Naturally, a user reading the user guide would want to know what commands are available after doing the start command and going into workout mode. However, the next 3 sections are "achievements", "clear_achievements" and "ippt ..." and only after those 3 will users get to read what can be done after using the start command. The 3 sections mentioned are all unable to be used while in workout mode (after running start command). After looking at the user guide's table of contents again, I noticed that I can be redirected to the "Within your workout session" section. However, I still feel that a normal user would not want to scroll all the way back up or go to the table of contents just to figure out what to do next. Perhaps start could be the last command in the "General" section so that the "Within your workout session" section comes up immediately after?