nus-se-bot
commented
11 months ago Team's Response
The UG very specifically stated that the user should be keying in the commands line by line. In addition, when actually executing the command, after typing "addrecipe", the command result box gives instructions on what the user should type in next. Hence, the lack of visuals should not inconvenience the users very much though a diagram would be helpful. Hence we do not think this is a Medium bug as this would entail a more major inconvenience to the user and thus we believe it is a Low bug.
It is also a duplicate of #5614, which covers the lack of visuals in the UG overall.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Lack of Visuals in the UG
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.
There are no visuals in the feature section. This may slow down the progress of users learning this application, as visuals can help them acknowledge what is the command format and what will be the expected output of a command.
[original: nus-cs2103-AY2324S1/pe-interim#5368] [original labels: severity.Low type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
We accept this bug for what it is.
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.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
The documentation of the add command should have "entered one by one" bolded to attract more attention from the readers.
This is the most important command of the application, so it may need more explanation to help users understand. The example alone may be not enough. Visuals of how the command works should be provided.