amzhy / pe

0 stars 0 forks source link

Information repeated many times in UG #17

Open amzhy opened 2 years ago

amzhy commented 2 years ago

image.png

This is mentioned in almost every command description, perhaps it could be mentioned once at the start, as index is commonly used for almost every command, users might find it repetitive

nus-pe-bot commented 2 years ago

Team's Response

We cannot assume that the users will read every command in the user guide or the general information. The users are likely to navigate to the commands that they are trying to find out, and the information for the commands should then be more explicit and contain all the relevant information for that command without any additional navigation required.

Furthermore, this is just a cosmetic issue, and can never be an issue higher than very low.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The information that index must be positive and refers to the number in the displayed list is repeated in every command description. While I agree that users would just jump to the command they would like to use, users are also likely to use more than one command in the app. As such, user would find the explanation for index in every command description repetitive. Such repetitive information can be abstracted separately as requirements for the index, so users can learn new commands more efficiently

image.png


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]