search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

Unclear documentation for delete-t command #3510

Open nus-se-script opened 11 months ago

nus-se-script commented 11 months ago

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.

[Command] delete-t

[Description] List of all tutors in the application:

Screenshot 2023-11-17 at 5.04.15 PM.pngScreenshot 2023-11-17 at 5.04.15 PM

When the user filters the list of tutors for the profile they want to delete using the find-t command, and tries to delete the profile of Alex Yeoh which has an index 3 as stated earlier, the user is unable to do so and encounters this error message.

Screenshot 2023-11-17 at 5.22.27 PM.pngScreenshot 2023-11-17 at 5.22.27 PM

Since the UG states that the index to be used when deleting a tutor is the index of the profile when the list-t command is executed, it should be clearly stated in the UG that the index to be used to delete a profile when the user filters the list of tutors should be the index of the tutor in the filtered list.

Please refer to the screenshot of the UG below. Thank you!

Screenshot 2023-11-17 at 5.04.08 PM.pngScreenshot 2023-11-17 at 5.04.08 PM

[Why is it Medium] Since the user might accidentally delete a profile that they don't intend to delete if they execute the delete command after filtering the list, it will cause confusion and troubles the user to reenter the details of the wrongly deleted profile. It is important to note that if the user does not realise that they have delete the wrong profile, they might not be able to retrieve back the contact information of the deleted profile. Additionally, since there is no confirmation button for the user to press before deleting a profile, it would be better is the user guide was more clear regarding this issue.

[original: nus-cs2103-AY2324S1/pe-interim#4894] [original labels: type.DocumentationBug severity.Medium]

Jweng88 commented 11 months ago

Team's Response

It seems that you may have performed an additional step to filter the list first before deleting the tutor, which is not part of the documentation.

From the instructions of the UG, the user would get the index of the tutor to be deleted after typing the list-t command, and not the find-t command. There was no mention of filtering the list after using the list-t command.

Since the steps in the UG stated clearly to get the index after the list-t command, if the user follows closely the steps to delete the tutor, which does not include filtering the list, the user would not encounter the problem of deleting the wrong tutor as the index used would be the correct one obtained after the list-t command.

The severity of this issue should be Low, since it is rare that users will deviate from documentation in using an app that they are unsure about to have executed an additional command not part of the documentation, and thereby unintentionally deleted a user. Regarding your concern about users not realising they have deleted the wrong profile, there is a success message on successful delete to show the person that has been deleted. It is thus even more rare that users do not realise who they have deleted.

Duplicate status (if any):

--