wengkit1 / pe

0 stars 0 forks source link

Adding an appointment has unclear instructions #4

Open wengkit1 opened 1 year ago

wengkit1 commented 1 year ago

Bug Title: When trying to add an appointment, the instructions are very unclear.

Description

Using the user command stated in help page for add appointment, will indicate that add appointment has a shortcut of 'ap' which is already used for add patient.

Steps to Reproduce

  1. Open app
  2. Click on help
  3. Look at user command instructions for adding appointment.

Expected behavior

The shortcut word for different commands should be different.

Actual behavior

They are the same. Screenshot 2023-04-14 at 2.37.38 PM.png

Environment

Additional Information

Severity and Type

This can be a functionality bug, as it is unclear if ap is implemented as both add patient and add appointment. However, it is only medium severity, as using the normal command still works, and is not app breaking.

nus-pe-script 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]

add appointment command shortcut

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.


This is a previously mentioned issue refer to issue#4, however I believe it classifies as both types of bug. As UG states a behaviour that is either not in the app or not apparent to the user. ap is used in "add_patient" already.

Screenshot 2023-04-14 at 3.19.32 PM.png


[original: nus-cs2103-AY2223S2/pe-interim#1614] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

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

This was a typo in our UG that wasn't caught. Thanks for reporting the bug!

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: While appearing to be highlight the same portion of UG, the nature of both bugs are different. One highlights the fact that shortcut words in UG, should be unique otherwise should work as intended.

This issue is highlighting the fact that while unclear if this shortcut word is actually one promising the behaviour, or merely a careless miss-out by dev team, the user can assume that it works. But it does not, therefore a functionality issue.


## :question: Issue type Team chose [`type.DocumentationBug`] Originally [`type.FunctionalityBug`] - [x] I disagree **Reason for disagreement:** I believe this classifies as functionality, as the ap command itself is not working as intended in the app. It falls under this category: These are considered functionality bugs: Behavior differs from the User Guide As the ap is promised to be able to be used to add an appointment, because this does not work in the app, it is actually a functionality bug.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** For a lazy user, doing an ap command leads to a much different behaviour than expected. So I do not believe that is merely a cosmetic issue, nor causing minor convenience. But using the command leads to more than minor inconvenience.