search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

UserGuide Glossary could include more terms #3396

Open nus-se-script opened 7 months ago

nus-se-script commented 7 months ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

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.

[original: nus-cs2103-AY2324S2/pe-interim#2827] [original labels: severity.Medium type.DocumentationBug]

wapisai commented 7 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.

Duplicate status (if any):

--