search

J-wang-CSMA / pe

0 stars 0 forks source link

The section on the "delete" command in the User Guide can benefit from a "before" image #10

Open J-wang-CSMA opened 5 months ago

J-wang-CSMA commented 5 months ago

Expected

A pair of images, before and after to showcase what has been deleted and how the UI changes.

Actual

Only the after image was provided. This can lead to new users not being aware of how the information displayed on the GUI changed according to the command.

image.png

nus-pe-script commented 5 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

In the UG, none of the features have before/after images

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.

It can be hard to follow some commands like 'edite' 'deletee' and it would be useful if the UG showed what was displayed before and after the command was executed.

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

Their Response to the 'Original' Bug

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

Hi, thanks for pointing this out :3

However, we have already added a note in the UG that the state of the data before each example is that of the original sample data. We believe that adding a before / after image for all our features would actually clutter the UG more, and hence, we made the decision to format our UG in this manner.

image.png

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.Rejected`] - [x] I disagree **Reason for disagreement:** While the group have stated that the "before" data is the original state of the base sample data, the original state of the base sample data is changed after any command the user uses to modify the list. Hence, the audience can only refer to the original state once (when they first open up the application) when they test out the commands, which still demands some kind of before image or at least some markings to clearly indicate what has changed with the command given.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** This is not just a cosmetic or formatting issue.