kayabuttertoastt / pe

0 stars 0 forks source link

Unclear documentation for delete-t command #7

Open kayabuttertoastt opened 11 months ago

kayabuttertoastt commented 11 months ago

[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.

nus-pe-bot 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.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thank you for your response. However, it is not clearly stated in the UG that the user should not type any other commands after getting the index of the tutor to be deleted after typing the list-t command. Hence, it is possible for the user to execute other commands such as find-t before deleting the user. The UG only explicitly states that the index used should be that of the profile while the list-t command is executed. Since, it is possible to delete a user by the index after executing the find-t command and it is possible for the user to delete a profile after executing the find-t command, it is important to inform the user that the index of the profile that they want to delete should be the index of the profile of the command (list-t or find-t) that is executed right before executing the delete-t command.

Since it is normal for a user to want to find the profile of the user and hence execute the find-t command before deleting the profile, this is a valid bug that has to be addressed.


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** The severity of this issue has to be Medium. This is because is it possible for the user to delete the wrong profile if they execute another command apart from the `list-t` command before executing the `delete-t` command. This is especially the case when the index of the profile in the `list-t` command is low (1 or 2) and hence, they might delete the wrong profile or be confused by the error message since it is not stated in the UG that they strictly have to execute the `delete-t` command right after the `list-t` command is executed. Additionally, there is no confirmation by the user when the `delete-t` command is executed to confirm that he profile to be deleted is correct. Moreover, since there is no simple command to add back the profile that has just been deleted it is troublesome for the user to reenter the details if they delete the wrong profile. It is to be noted that this is only if they realise that the profile they deleted is wrong when reading the success message. If user skips reading the success message since it is not very prominently displayed (no change in colour or font size from the others to immediately grab the user's attention), the user might not be able to retrieve back the contact information of the deleted profile. Since this can happen to a large number of users since normal for a user to want to find the profile of the user and hence execute the `find-t` command before deleting the profile, just like me in this case, and it will cause inconvenience to them (the only difference is the level of inconvenience depending on whether they get a error message that the index is invalid, realise they delete the wrong message based on the success message or not realising they deleted the wrong profile) the severity of this issue is Medium.