insafhere / pe

0 stars 0 forks source link

Incorrect format of optional and required fields for search #7

Open insafhere opened 1 year ago

insafhere commented 1 year ago

From UG:

image.png

Perhaps can standardize to separate the required fields :

so instead of:

search [ /code PARTIAL_MODULE_CODE | /title KEYWORD ] < /level MODULE_LEVEL > </sem SEMESTER >

Can be like this instead:

search [ /code PARTIAL_MODULE_CODE ] [ /title KEYWORD ] < /level MODULE_LEVEL > </sem SEMESTER >

Having the "|" is misleading meaning that it is an OR field but it is not OR as it can be both /code and /title to be present in the case of "search /code CS /title algorithm /level 5 /sem 2" as mentioned in UG

nus-se-script commented 1 year ago

Team's Response

search [ /code PARTIAL_MODULE_CODE ] [ /title KEYWORD ] < /level MODULE_LEVEL > < /sem SEMESTER > would indicate that each of the parameters /code and /title are required. Search command however minimally requires only one of them.

The user guide states,

image.png

and further down,

image.png

lastly for users who might still be confused, an example is shown

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: This standardization is not being used consistently throughout the user guide which is very confusing.


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]