macareonie / pe

0 stars 0 forks source link

UserGuide Glossary could include more terms #6

Open macareonie opened 2 months ago

macareonie commented 2 months ago

Given the target audience as the real estate industry or a real estate agent to be exact, I assume the user would not be familiar with terms that may seem like common knowledge to us, especially if they were less tech-savvy or from older generations.

Terms like alphanumeric, parameters, integer overflow, non-zero unsigned integer etc. should be considered potential additions to the glossary in the userguide.

soc-se-bot commented 2 months ago

Team's Response

Thank you for pointing this out, we will add more terms in future iterations, however, currently we believe that our glossary is sufficient in providing definitions for words that users are highly likely to be unfamiliar to. We believe that the terms you have provided are well understood by the majority of our target users.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: The team didn't really justify how the current glossary is sufficient for the target users of real estate agents. I can accept terms like alphanumeric being more intuitive for such an audience, but for terms like integer, let alone integer overflow or non-zero unsigned integer (which I did not encounter until entering the CS field), I don't believe people outside the field would understand them. Terms like these require background knowledge on their own and even a hyperlink to an external site may not actually help in understanding the terms. Furthermore, there are cases where they are bolded as well, signifying important information (as per user guide formatting conventions), which further confuses users.

In a user guide, I don't think it is necessary to even include such technical jargon in the first place as it causes unnecessary confusion for users and hinders their overall experience.


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** As stated above, these technical jargons/terms do occur multiple times throughout the user guide and is not a rare occurrence to say the least. Given this, I would classify this as a occasional occurrence and keep the severity level at medium.