ijavierja / pe

0 stars 0 forks source link

UG - examples listed for the features are not ordered. #4

Open ijavierja opened 3 years ago

ijavierja commented 3 years ago

During manual testing, a basic test would be to use the examples listed in the feature section to check if the what was documented was implemented. So, I think it would be best if the examples can be listed chronologically and the examples would give the expected result if the UG's examples were inputted in order.

Add-worker example doesnt work role not yet in the role list.PNG

In this example, the role was not yet added to the role list so the example failed. Perhaps

nus-se-bot commented 3 years ago

Team's Response

This should not be considered a bug as it is just a possible example. Furthermore, referring to the highlighted point in the first screenshot below, it is clearly stated before providing the examples that the ROLE must exist in the app and it also provides a hyperlink to the section that describes how to add a role to the app. If the user were to indeed use this example, the error message displayed as shown in the second screenshot also clearly pinpoints the problem with the command, allowing the user to easily troubleshoot by referring to the hyperlink in the UG. Thus, it is very unlikely that the user will be confused and in fact, this allows the user to be even more aware of the constraints of this command.

The severity has been dropped to low as this is only encountered for this specific example given in the specific case where a new user uses the sample data to test the commands.

Screenshot 2020-11-14 at 7.23.53 PM.png

Screenshot 2020-11-14 at 7.52.32 PM.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your reason]


:question: Issue severity

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

Reason for disagreement: [replace this with your reason]