yleeyilin / pe

0 stars 0 forks source link

Vague explanation in user guide for illness input #21

Open yleeyilin opened 7 months ago

yleeyilin commented 7 months ago

Below is a screenshot of your user guide:

image.png

Expected / Possible Improvements: According to the user guide, I should be able to type in edit 1 I/me since this illness corresponds to a valid name. However, the user guide did not state that it should only correspond to a single category.

Being clearer can ensure that your reader / user will not be confused and type in the wrong input.

soc-se-bot commented 7 months ago

Team's Response

Though might be unclear, the user guide states "... as long it corresponds to a valid name for convenience" which states that it should only reflect to a single category. Though, we also understand that it is easily missed hence we would definitely improve the phrasing in future releases. NotInScope

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: From the TP rubrics, what it means to be a valid NotInScope for grammatical error means that it does not hinder the reader. This in fact does hinder the user since it is vague and does not imply ONLY ONE valid name.

image.png

Below is a screenshot of what "a" means grammatically:

image.png (https://gallaudet.edu/student-success/tutorial-center/english-center/grammar-and-vocabulary/definite-and-indefinite-articles/when-to-use-a-an-or-the/)

In other words, what your UG is implying is that we only need to key in the TAG as long as it corresponds to ONE-OF-MANY valid names, which is different from your intention of ONLY ONE valid name.

This could cause confusion to the readers, as your group also agrees, who may be trying to figure out how the shortcut works since your UG means that "me" should be accepted since it corresponds to ONE-OF-MANY valid names.