search

dohaduong / pe

0 stars 0 forks source link

Wrong/Inconsistent command format for `edit` as Removing a person from a team #5

Open dohaduong opened 1 year ago

dohaduong commented 1 year ago

The format in UG states that to remove a person from a team, the format that users should follow is edit INDEX [T/TEAM_NAME], however, using the command edit 1 in the app seems like this format is only used for "editing a person" and not for removing a person from a team (see img).

I think the correct format for "removing a person from a team" should have been stated as edit INDEX T/ or edit INDEX T/TEAM_NAME..., so that users could tell the difference between the original edit command and remove person from team command.

Thus, I would consider this as documentation flaw.

image.png

soc-pe-bot commented 1 year ago

Team's Response

Agreed that this would cause confusion for the users as the T/TEAM_NAME is not suppose to be optional when removing a teammate from a team, therefore it is a typo to surround T/TEAM_NAME with [ ]

Reasons for lowering severity to low

1) It is unlikely to cause substantial confusion as an example is given right below the command format

image.png

2) An error message would be produced if the user enters edit 1 (the example input used by the tester). Therefore, it would only lead to a mild inconvenience for the user to reinput the command should the team name prefix(T/) not be included previously.

image.png

3) In the DG, under Appendix: Planned Enhancements, we plan to separate out removing a person from a team with a new command remove_from_team. We hope this would also lead to less confusion down the road by not sharing the edit command.

image.png

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Low] Originally [severity.Medium]

Reason for disagreement: 1, I disagree with the team regarding point 1. Even though an example is provided, the format is still incorrect. The user could use the format command before reading the example in detail, thus could cause inconvenience. The format edit INDEX is used for editing a person, thus saying that "Removing a person from a team" has the same format is clearly incorrect and will

The format is simply incorrect - which cause inconvenience to most users, no "rarely some user", thus is of Medium severity.

2, Even though an error message will be displayed, this would still cause occasional inconvenience and confusion to users as (s)he may continue to use the wrong format next time (s)he uses the command. I believe this should be of Medium severity, as it causes occasional inconvenience yet user can still proceed to use the app (like what the team mentioned - retype the command and continue to use the app).

3, I disagree that Appendix: Enhancement is of any relevant to the bug, as the current version is including the wrong format for the command in the UG, not the future one. However, as pointed out by the team themselves, the edit command has so many version and uses (one can use it to edit a person, or edit a team, or add a person to a team,...) - the command itself has so many different formats and usages, thus it is of high importance that the format should be clear and different for each version of edit. This is to reduce confusion among users.

Moreover, since edit has so many versions, it is highly likely that users will not be able to remember the specific format for each version, thus stating the format clearly helps to enhance user experience. Therefore, a correct format for edit is very important and thus the bug is of Medium severity.