tayjerom / pe

0 stars 0 forks source link

Date format to be indicated on Command Summary #4

Open tayjerom opened 1 week ago

tayjerom commented 1 week ago

image.png

Since documentation prompt date format (shown in screenshot) as "2024-11-11", but date format accepted is in "dd/mm/yyyy". Would recommend to indicate in UG command summary that date format expected is "dd/mm/yyyy".

nus-pe-script commented 1 week ago

Team's Response

image.png

The proper format of dd/mm/yyyy is indicated in both UG and DG with regard to input date formatting. While it is a good to have for it to be shown in the command summary, it is already present in UG.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: As a tester (end-user), I believe the criticality of a [Command Summary] section being to provide quick reference for users.

If expected date format is different from example shown in other section such as one i faced while using this application [YYYY-MM-DD] vs [DD/MM/YYYY], this inconsistency will greatly cause confusion to users.

Even though the team stated that date format is mentioned elsewhere in UG, it is still crucial to indicate in Command Summary to avoid unnecessary user mistakes, which makes this a valid improvement to be consider and definitely not out of scope.


## :question: Issue type Team chose [`type.FeatureFlaw`] Originally [`type.DocumentationBug`] - [x] I disagree **Reason for disagreement:** This issue falls better as a [DocumentationBug] due to the nature of having incomplete/unclear instructions in their User Guide.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** Incorrect date format inputs can potentially hinder user experience, causing them to repeat using the commands due to error faced due to repeatedly having to match the date format; relating to the inconsistency in documentation causing format mismatch without warning user upfront about the format expected. This potentially cause disruption to the workflow of end users. I would still recommend indicating in the [Command Summary] explicitly documenting the required date format as ( DD/MM/YYYY ) within all relevant commands; to reduce user errors.