search

RyanNgWH / pe

0 stars 0 forks source link

Searching commands do not specify how each fields are matched #16

Open RyanNgWH opened 2 months ago

RyanNgWH commented 2 months ago

image.png

For the 3 commands that perform searches (find, patient and doctor), the UG simply states "find [doctor or patient or both] whose details contain any of the given keywords"

While it does specify for each command which fields can be searched for each command, it does not specify how the fields are being matched.

Example:

image.png

This example shows that users can search the DOB of doctors, however, using the command doctor January does not return any doctors with birthdays in January.

I believe this to be a medium severity as this seems like a very likely scenario for users of the application and there is no easy way for users to know the exact format they should enter to get the result that they want

soc-se-bot commented 2 months ago

Team's Response

Thank you for raising this. Indeed, we acknowledge this is an issue with the documentation. The query commands matches the numerical birthday and not the string of the month. Thus our example should be corrected. However, we feel that this can be fixed with a very simple change to doctor 01-30. Overall, this issue does not hinder the use of this command for most users.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: The team mentioned that "this issue does not hinder the use of this command for most users". However, I believe that while it does not hinder the functionality of the command, the lack of explanation of how the field is being matched does in fact hinder the use of this command for most users.

Based on the current description of the command as shown in the screenshot of the issue, the user only has 1 example (doctor 30 Jan) of how to use the command to search for doctors based on their birthday. Considering that the target audience of the application is admin staff of hospitals, I believe that it is highly unlikely that most of them would have the technical knowledge to decipher how 30 Jan is being matched.

Based on the team's suggestion to simply change the example to doctor 01-30 and the description that the command is able to find doctors "whose details contain any of the given keywords", I, as a user, would be led to believe that it is possible to search doctors by birthday month using a command such as doctor January. However, this does not seem to be possible and the new example would not help in this case.

Therefore, I feel that the lack of documentation in this case would hinder the use of this command for most users in the sense that they would not be able to correctly use the command to find doctors as they are very unlikely to know how the command works.