boonhaii / pe

0 stars 0 forks source link

Missing Explanation on Subject Field #3

Open boonhaii opened 2 years ago

boonhaii commented 2 years ago

In the User Guide under the section on "Find", there is a field for "subject", but this has not been explained to the user.

Screenshot 2021-11-12 at 4.25.45 PM.png

nus-pe-bot commented 2 years ago

Team's Response

there is a field for "subject", but this has not been explained to the user.

This is untrue. "subject" is used in the "Setting up your first tutee" section, preceding where this screenshot is taken, which all new users would have familiarised themselves with the entire workflow and all the necessary terms. See Point 3:

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The subject field is part of the addLesson feature of the application. While an example has been provided, the User Guide does not state the acceptable range of values that can be used for the Subject field, even in the section under addLesson.

This would confuse the reader as the reader has no idea the range of values that accepted and values that are not accepted.

In an unlikely case, readers may decide to use special characters while using the application, thinking that it is acceptable. Since the application correctly rejects the value used for subject, it is not a FunctionalityBug. Thus, it was classified as a DocumentationBug where an explanation regarding the accepted values should have been given.


:question: Issue severity

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

Reason for disagreement: Severity of this issue should not be severity.VeryLow as it is more than a cosmetic issue, and affects the functionality of the application. While it is highly unlikely for the User to use non-alphanumeric characters (eg. Design & Technology), it can cause a minor inconvenience since the user has to adjust the subject field before re-submitting the command. Thus, it is classified as severity.Low.