XylusChen / pe

0 stars 0 forks source link

The undo command needs more detailed documentation #14

Open XylusChen opened 1 year ago

XylusChen commented 1 year ago

There are many commands that cannot be undone. For example, backup-related commands cannot be undone. The current amount of documentation for undo is insufficient to show users which commands can be undone and which cannot. This can potentially hinder the user significantly due to possible wrong understanding of how undo command works.

image.png

soc-pe-bot commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

description for undo command not clear

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.


Undo command can't undo commands like find, list and view. But it's not specified in the UG.

image.png


[original: nus-cs2103-AY2223S2/pe-interim#1389] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Thank you for bringing up this matter. We appreciate your valuable input and would like to address your concerns in detail. We acknowledge that it is a valid point that we could mention this information in our User Guide, similar to what we have done in our Developer Guide. However, we did not include it in our User Guide because our short prompt indicated that the previous change was a mistake, and the commands you mentioned, such as 'list', 'view', or 'find', do not modify the current user data. We assumed that the readers of the User Guide would have the necessary expertise to understand this point.

We understand that you may have interpreted the lack of this information as a documentation bug. However, we do not see it as such. We do believe that adding this information to the User Guide would enhance its overall value and be a valuable addition. We appreciate your suggestion and will certainly consider it for future updates to our documentation.

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)

Reason for disagreement: [replace this with your explanation]


## :question: Issue response Team chose [`response.NotInScope`] - [ ] 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]