eugenecsa / pe

0 stars 0 forks source link

Format of fields are not specified in UG #15

Open eugenecsa opened 2 years ago

eugenecsa commented 2 years ago

The format of the user's inputs are not specified except for the date time formats. For example, the constraint on name being only alphanumeric and phone number being at least 3 digits long are not specified anywhere in the UG.

Users who are unaware will encounter error messages and have to correct the input for each tag one after another due to the errors only showing up for one tag one at a time.

nus-pe-bot commented 2 years ago

Team's Response

image.png

^ From https://nus-cs2103-ay2122s1.github.io/website/admin/tp-deliverables.html#deliverable-user-guide-ug

It is unlikely for the user to enter some invalid field format on purpose. Even if they do so, they will be warned by SoConnect if they attempt to enter an invalid field.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: While it is not necessary for the UG to include every nitty-gritty detail, information about the input is important in the UG. As the UG is a guide for the user to get started with the product, it is important for the user to be aware of what input can be entered for the different fields, so that they will know what format of input is accepted. Having to read an error message to find out and correct it is an inconvenience that can be avoided. For example, name can only be alphanumeric, but some people have names that include special characters such as , or . which gets rejected as the user is unaware that names can only be alphanumeric.