tim-pipi / pe

0 stars 0 forks source link

Confusing UG #13

Open tim-pipi opened 11 months ago

tim-pipi commented 11 months ago

image.png

Perhaps 'contains NAME' would be a better choice of words - so that user does not have to decipher the meaning of this sentence?

nus-se-script commented 11 months ago

Team's Response

It is already stated under notes about command format that words in uppercase should be parameters supplied by the user.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Hi there,

Thank you for your response. While I understand that uppercase words in the command format are meant to be parameters supplied by the user, my concern is more about the clarity of the description of the findcust command in the User Guide.

Clarity in Command Descriptions: The current wording, "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," might be confusing for users. It could be interpreted in multiple ways, leading to uncertainty about how exactly the command functions.

Enhancing User Understanding: A clearer description, such as "Finds and returns a customer or a list of customers whose first name, middle name, or last name begins with the specified NAME," would directly convey the command's functionality. This phrasing eliminates ambiguity and makes it easier for users to understand how to use the command effectively.

Given these considerations, I believe that revising the description of the findcust command in the User Guide to be more straightforward and explicit about its functionality would significantly enhance the guide's usefulness and user-friendliness. As such, I believe that this bug is a valid one that the team should consider!