search

muhammad-faruq / pe

0 stars 0 forks source link

No mention of the date of birth format #3

Open muhammad-faruq opened 2 years ago

muhammad-faruq commented 2 years ago

image.png

There is no mention as to how the DOB should be formatted. There are many different formats for dates and a mention as to how this app requires the format would be useful to the user. While the user can find the way to input through the Examples:, it would still be better and clearer to explicitly state the required format.

nus-pe-bot commented 2 years ago

Team's Response

It is clearly implied in the example how the date of birth should be formatted. Having the date of birth here ensures that the UG is brief and the intended message is delivered.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The User Guide is not meant to imply to the users how commands should be used. It is meant to explain to the user how commands should be used. With this kind of argument, you can simply omit all details and imply to the user on how commands should be specified by just stating one example.

I believe that this is a Documentation Bug with Severity: Low as personally I as a user was not able to find the date format and had to try out and figure it out based on the examples given. Again this should not be the purpose of the UG "to let the user go figure". This should not be Severity: VeryLow as it is in fact not a cosmetic issue.