tim-pipi / pe

0 stars 0 forks source link

Parameters doesn't match UG #12

Open tim-pipi opened 11 months ago

tim-pipi commented 11 months ago

image.png

The current error message displays KEYWORDS as the parameters. However, in the UG, the find only works to find name. This may be misleading some users.

image.png

nus-se-script commented 11 months ago

Team's Response

image.png

we do understand your concerns, but in the examples given users should be able to tell what kind of parameters are accepted

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: Hi there,

I appreciate your acknowledgment of my concerns regarding the findcust function. While I understand that the examples in the User Guide might clarify the expected behavior, there are several key points to consider:

The application suggest that findcust finds all customers whose names contain any of the specified keywords (case-insensitive) and displays them as a list with index numbers. However, the actual behavior of the application does not work like this. Instead it follows the behavior advertised by the User Guide instead - "Finds and returns a customer or a list of customers, from all your customers whose name begins with NAME at any position within their name". This is confusing for users as it may lead to user thinking that the findcust does not work.

Consistency Between Documentation and Application: There is a discrepancy between what the application suggests and what is detailed in the User Guide regarding the findcust function. Such inconsistencies can lead to confusion and a perception that the feature is not working correctly. Users often rely on the application's immediate instructions or prompts, which in this case, do not align with the actual functionality.

Application: "finds all customers whose names contain any of the specified keywords (case-insensitive) and displays them as a list with index numbers."

User Guide: "Finds and returns a customer or a list of customers, from all your customers whose name begins with NAME at any position within their name" (The application follows this behavior)

Accessibility of Documentation: Not all users may have constant access to the User Guide, especially when using the application. Users should be able to understand and use basic features like findcust based on the application's built-in guidance and error messages. If these are not accurate or aligned with the actual behavior, it diminishes the usability of the application.

Importance of Accurate Error Messages: If the behavior advertised by the error message differs from that in the User Guide, this inconsistency needs to be addressed. Error messages are a critical part of user interaction and should accurately reflect the application's functionality to guide users effectively.

Given these considerations, I believe that this is a valid bug within the scope of the current application.