nus-pe-bot
commented
3 years ago Team's Response
No response provided.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Confusing terms
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.
I'm not really sure what is y and what is n in this context.. Readers reading this might be confused... Perhaps its better to state what y and n means...
[original: nus-cs2103-AY2021S2/pe-interim#2347] [original labels: severity.Low type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
Both the user guide and the warning text message found in the command result box of TutorPets have stated that 'y' and 'n' are inputs that users are required to be entered into the command box so as to confirm whether to proceed with the current command.
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: The team responded by saying that the explanation for 'y' and 'n' are present in both the user guide and the warning text message found in the application. However, this bug occur in the developer guide and there is no explanation for it in the developer guide.
Moreover, the user guide and developer guide are separate documents and cater to different type of users. Explaining it in the user guide does not mean that the explanation can be omitted in the developer guide. Perhaps, it would be better to reiterate what 'y' or 'n' means in the developer guide or provide a hyperlink to the part that 'y' or 'n' is explained in the user guide.
Since this bug occur in the developer guide and is not properly explained in the developer guide, it is thus a valid bug.
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: The issue should not be counted as duplicated as this bug occur in different documents.
Notably, the bug occurs in the user guide and developer guide with the team responding explanation is provided in the user guide and application. They did not address the issue of whether or not the explanation is present in the developer guide.
Moreover, the user guide and developer guide are separate documents and cater to different type of users. Explaining it in the user guide does not mean that the explanation can be omitted in the developer guide. Hence, this should not be counted as a duplicated bug.
Attached are screenshots to show that the bug comes from different documents.
This is the original bug report.
This is the current bug report mark as duplicated.
:question: Issue severity
Team chose [severity.Low]
Originally [severity.VeryLow]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
Not really sure what is y or n here... Might want to state what y or n means...