nus-pe-script
commented
5 months ago Team's Response
Our user guide is already 16 pages long, which is quite a lot for any user to read. We felt that adding more cases than necessary would clutter the user guide, making it less readable. Hence, we decided to only include one or two examples for each command in the user guide, specifically choosing examples that we felt would be most used by the user.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
not enough examples in 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 not enough output examples in the UG. for example, the the "delete" command only has one output example. this makes the UG less visual. making the Ug more visual is better since it becomes easier to read for the user.
[original: nus-cs2113-AY2324S2/pe-interim#1900] [original labels: severity.Low type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
Our user guide is already 16 pages long, which is quite a lot for any user to read. We felt that adding more cases than necessary would clutter the user guide, making it less readable. Hence, we decided to only include one or two examples for each command in the user guide, specifically choosing examples that we felt would be most used by the user.
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)
- [x] I disagree
Reason for disagreement: This is not a duplicate of the other issues raised. this issue is about the update command. when I read it again, I see how this might not be as clear as I intended it to be. however, this issue pertains to the update command and helping the user understand how the command might be used without some of the optional parameters, while the other issue pertains to a general lack of examples in the UG.
## :question: Issue response Team chose [`response.NotInScope`] - [x] I disagree **Reason for disagreement:** adding one example where the parameters are not all used will not exceed 3 to 4 lines, which will not affect the length of the UG.
For example, for the "update" command, the output examples in the UG are only "update n/Milk q/200 p/10 e/15-06-2113" and "update n/Milk q/50 p/9.99 e/nil". it would be good if the user gets to see at least one output where not all three of the q/, p/ and e/ parameters are present since they are optional.