nus-pe-bot
commented
3 years ago Team's Response
Duplicate of #1307.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Insufficient examples in explanation of clear command 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.
In section 3.7 of the UG,Clearing all entries, it is stated that users should use theclearcommand with caution.However, it would be nice to have some examples of different contexts of when the target audience should and should not use the command, maybe as an appendix.
This would make the UG more user friendly and clearer as well.
[original: nus-cs2113-AY2021S2/pe-interim#1307] [original labels: severity.Medium type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
With reference to the screenshot you pasted in this issue, we have given an example of when to use the clear command in the 2nd sentence. We deemed that it was unnecessary to include it in the appendix in the UG, as it is sufficiently explained here.
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 issue, the 'Original' bug was more focused on examples of usages. The issue I submitted was because i faced a problem adding supposedly "new id's" after clearing.
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: This should not be rejected as i faced problems adding "new id's" after clearing. Hence, perhaps a clearer explanation in the UG would be better so that first time users of your program will know that historical data is still kept.
:question: Issue severity
Team chose [severity.VeryLow]
Originally [severity.Low]
- [x] I disagree
Reason for disagreement: Since it might affect the usage of the product, severity should be very low instead of low as it is not a cosmetic issue.
Might want to elaborate more on the Clear function in "3.7 Clearing all entries" and not within the FAQ. The name seems to suggests that it does a wipe all data, however historical ID's are still kept, which makes it extremely confusing when checking in supposedly "new" ID's as a user. This might not be a frequently asked questions as most users would assume it clears everything.