soc-se-bot
commented
1 week ago Team's Response
The Quick Start section guides users to launch the program and use the "help" command to access the full list of commands within Inventra. Our team intention is to keep this section concise for the purpose of "quick starting" the users into Inventra without confusion.
For comprehensive explanation of all commands within Inventra, please refer to the "Features" section in the User Guide (UG).
We believe that this quick start section has indeed served its purpose in quickly getting user to launch Inventra and use the "help" command for further doubts.
We diagree with the statement "The quickstart does not showcase any basic commands to exemplify the overall usage of the application" As it is not the purpose or in the user's best interests to showcase basic commands in this section. Hence will be rejecting it this issue.
If this issue is not deemed to be rejected, then it should be a low instead of medium because it is a minor inconvenience to the user as he has to use the help command.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: Below I provide a screenshot of the UG discussed in the lecture materials.
As you can see, a first-time user's entry into the application is eased by providing a quick introduction to the most basic commands such as list, add, delete, clear and exit. These "pillar commands" are essential for helping users understand the application's purpose and functionality right from the start. Especially, since they set the tone about what a user can do with your app.
As a new user, I found these commands missing in your quickstart guide. Simply referencing the help command as the only command here is not enough for this purpose as every CLI app has a help command and its existence gives a user no further information about the app itself. Consequently, after running the .jar file and executing the help command, I was left unsure of the application's purpose or what to do next. Including a few basic commands with examples and explanations early on would have made a big difference in helping me get started more confidently.
This becomes especially important given that the Features section can feel a bit overwhelming at first glance, as pointed out by another PE tester in this related issue:
Therefore, while I agree with your decision to classify this as a low severity issue, I believe it should not be dismissed entirely. Providing a more user-friendly quickstart guide with some additional basic commands would significantly enhance the user experience. 😊
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
The quickstart does not showcase any basic commands to exemplify the overall usage of the application. As a user this makes it hard for me to understand how I can use the app.