search

waynezsy / pe

0 stars 0 forks source link

UG does not mention birthday date format #6

Open waynezsy opened 1 year ago

waynezsy commented 1 year ago

As per title. Users will have to infer or get it wrong and depend on the application error message to figure it out.

soc-pe-bot commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Birthday date format not specified in the UG

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

Under the birthday section of the UG, there is no mention of the expected format for date input. This can cause confusion and inconvenience as the user has to figure out the correct format from examples.

[original: nus-cs2103-AY2223S1/pe-interim#4745] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

image.png

App clearly shows it in the error message and can be easily rectified.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Although the app itself shows the format for a BIRTHDAY, this means that a user has to get it wrong first (or fret over not being able to find it in the UG before making a guess) before they can get it right. This is inherently detrimental to the user.

Consider a use case where the a user is using the BIRTHDAY parameter for the first time. They will have to get it wrong first (so as to find out the correct way to input a BIRTHDAY via the extension) before they can successfully achieve the MSS of the corresponding use case. I believe this counts as minor inconvenience since it disrupts the user experience when they are required to get something wrong before they can figure out how to use your app correctly. With no documentation, it is very possible to input BIRTHDAY date in a myriad of other ways on first attempt. The correct format of your parameter should not be considered a "nitty-gritty" that can be omitted from your UG.

Furthermore, the first command any user might use on your app is the add command to add a contact, which requires a BIRTHDAY. This is also the first command listed in your features section of the UG. They are unlikely to already know to how make use of other similar parameters such as DATE in the correct format. The point of the UG is to enable users to at least successfully achieve what they want to do if they follow your documentation, barring exceptional circumstance. Your user guide does not currently support this. It is not an exceptional circumstance to question what is the correct way to represent a BIRTHDAY date.

:question: Issue severity

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

Reason for disagreement: I believe the lack of documentation on the format for BIRTHDAY is likely to affect a majority of users on their first use of the application, though it should not affect anyone subsequently. Given that getting the BIRTHDAY wrong once is a minor inconvenience and that this lack of documentation will not affect normal operations (i.e. subsequent usages), I have set the severity to Low. Although, it is to be noted that I do not believe this will be a "rare" occurrence in the sense that almost everyone will encounter it as part of their initiation to the application. If we consider that this is a common bug everyone will be inconvenienced by, it may even be possible to upgrade severity to Medium.