search

SharlynLui / pe

0 stars 0 forks source link

Help display does not match user guide. #8

Open SharlynLui opened 5 months ago

SharlynLui commented 5 months ago

Results in "help" does not match the format of "results" in the UG. In the UG, the format given is "results [details] [attempt num']" however, under help it is just "results". image.png

image.png

nus-se-bot commented 5 months ago

Team's Response

Thank you very much for testing.

The [ATTEMPT_NUM] is only needed when the user has attempted to a question set multiple times. The results [RESULTS_INDEX] command, as listed in the built-in command, should work properly.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: image.png

The mismatch in the UG and application for the usage of the command results hinders any user who refers to the help list in the application for the usage of results as it only shows results [RESULTS_INDEX] and does not show that users can also add the [ATTEMPT_NUM] at the back. It is also a valid feature flaw as it is a functionality not delivered according to the possible commands listed in the app.

Furthermore, this mismatch in the UG and application help list also confuses users referring to both the help list and UG. In the UG, the team wrote results [details] [ATTEMPT_NUM] and wrote results [RESULTS_INDEX] in the help list. These three different parameters are very confusing for the users as they would not know if it is 3 separate parameters or repeated parameters. If the [details] meant the results index or the attempt number?

Thus, according to the guidelines, it is a flaw that is unlikely to affect the normal operations of the product if the user follow the UG or help list alone. However, for users following the help list, it will cause inconvenience as they will not know how to check the results for topics with multiple attempts. Additionally, it will also inconvenience users looking at both the UG and the help list as they will have to guess if the three parameters are separate or overlapping and test how to use them.