ling-ui / pe

0 stars 0 forks source link

Delete example states to include index instead of id #10

Open ling-ui opened 2 years ago

ling-ui commented 2 years ago

image.png In the command summary section, the format given states INDEX which should not be the case, since the feature explanation earlier in the UG and the actual app uses the ID of the employee (which differs from the INDEX). User might end up deleting the wrong employee which cannot be undone and will cause major inconvenience.

nus-pe-script commented 1 year ago

Team's Response

This issue is also regarding the same mistake in the "Command Summary" segment.

The 'Original' Bug

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

[UG] Delete in command summary differs from the top

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 the selection on deleting employee ID, the command format is delete ID, but in the command summary, it is delete INDEX. It could cause confusion to the user.

image.png

image.png


[original: nus-cs2103-AY2223S1/pe-interim#2878] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

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

Hi there! Thanks so much for the report.

We accept this bug.

Once again, thank you so much for informing us regarding the error.

Cheers,
Coydir
HR is hard, Coydir is easy
(est. 2022)

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 severity

Team chose [severity.VeryLow] Originally [severity.High]

Reason for disagreement: After much thought, this bug might not stand at a "High" severity since it is a UG bug and perhaps, some users might use the app or this particular command without referring to the command summary part of the UG, hence not being affected. However, this still deserves to be of at least a "Medium" severity.

Firstly, this error is not merely a cosmetic issue, hence it should not be of "Very Low" severity. A person's INDEX and ID do not refer to the same thing and are likely to have different values. By following this command format given, the usage of the app is affected since the user might end up deleting the wrong person.

As mentioned in the original bug report, the delete command is not reversible. If a reader were to refer to the command summary part of the UG to use the app, which is likely due to the convenience it brings in learning an app with multiple complex commands, the user might end up deleting the wrong person. This deletes all the relevant information, including the ratings of the person. Since the app is supposed to allow users to view a person's rating history which is time-sensitive (only one rating can be given a day), it is not even possible to add all these information again, bringing major inconveniences to the user.