sylviaokt / pe

0 stars 0 forks source link

UG - difficult terms not explained #13

Open sylviaokt opened 3 years ago

sylviaokt commented 3 years ago

There are terms used in the user guide that might not be understood by the target audience. For instance, parameters, extraneous and mutually-exclusive. There appears to be a lacking of explanation for these terms, and users might find it confusing since they do not understand these terms. Perhaps it would be helpful to include a glossary for these terms.

image.png

image.png

nus-pe-bot commented 3 years ago

Team's Response

These are commonly used terms, so there is very little chance of misunderstanding/confusion.

Furthermore, they are general, not domain specific terms, and so a quick google would suffice even if a user has not heard of these terms. A glossary should not be a dictionary, and the time taken to google these terms would likely be comparable to looking it up in the glossary.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I do not believe that those terms are commonly used terms. The general public who has no experience with coding might not have the same understanding of parameters as computing students. In addition, extraneous is not a word used commonly as well.


:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: Severity should be Medium. The group mentioned that a quick google search would resolve the issue. However, terms such as parameter have different meanings under different context, and the readers might be confused after searching for the definition of parameter. Hence, usage of these terms might cause inconvenience and confusion to the readers. This might deter readers from reading the UG, and hence using the application if they do not understand what is going on in the UG.