nus-se-script
commented
2 months ago Team's Response
Thank you for your suggestion.
However, the number of examples are not meant to be standardized, since it depends on the complexity of the command. edit has more optional parameters, while add-skill is relatively simple. We also avoid repeating examples on hashtag notation to make the user guide easier to digest, so the illustrations on hashtag notation are not shown in add-skill and some other commands.
Hope this clarifies your concerns. We will be rejecting this bug since standardizing the number of examples could lead to a degradation in quality of the user guide.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: I disagree with the development team’s decision to reject this bug. While the complexity of commands can vary, it is essential for user documentation, such as the User Guide (UG), to maintain consistency in its instructional content. This includes providing a comparable number of examples for each command to ensure that users of all proficiency levels have ample guidance on using the software effectively. The disparity in the number of examples given—three for the edit command and only one for add-skill—could lead to confusion or a perception of inconsistency in documentation quality.
A standardized approach to the number of examples not only enhances the professionalism of the documentation but also improves user comprehension and ease of use. Users may rely heavily on these examples, especially for less intuitive commands or when they are new to the application. Ensuring each command is equally well-documented supports a smoother learning curve and better user experience.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
Here , edit command as 3 examples whereas add-skill only has one example.