nus-se-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: AB3 only provided 4 features out of a total of 8 features in their quick start section as shown in the screenshot provided.
The quick start section is meant to provide a short and succinct introduction to the app to allow the readers to understand and test the app briefly.
However, the team added their full commands in the quick start section, overwhelming the readers with many technical terms just at the start of the user guide. Hence, I believe that this is considered a documentation bug since it is not well formatted. I feel that the team should have reduced the number of commands in the quick start section to allow readers to have an easier time reading the user guide, especially at the start. Another suggestion is to include a tutorial section before the features section to briefly introduce all the commands with example. This would have made the user guide more coherent and neat.
:question: Issue severity
Team chose [severity.VeryLow]
Originally [severity.Medium]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
Point 5 of quick start indicated all of the commands that the application have. It overwhelms the readers with too much information at the start.
Can be seperated into a tutorial section instead.