search

winston-lim / pe

1 stars 0 forks source link

UG misses definitions for technical jargons #9

Open winston-lim opened 1 year ago

winston-lim commented 1 year ago

UG is for the end-users, and this UG assumes that users are developers. Examples of assumed knowledge:

  1. API - will normal end-users know what this is? This abbreviation is used throughout the UG(e.g. "updating data from API")
  2. API Key - will normal end-users know that you need an API Key to access this specific API? In fact, not all APIs require an API key
  3. Authentication - to devs this might be pretty brain dead, but to normal end-users, what is authentication?
  4. Filter - again, this seems very intuitive to the tech literate, but notice that most products do not use this word, and instead adopt "find" or "search"(LinkedIn, Google)

Also related why use "filter" over "find"?

soc-se-bot commented 1 year ago

Team's Response

Thanks for your report!

We agree that we should have listed the full word for "API". Hence we have accepted your report. However, we would like to contest that "API key", "authenticate" and "filter" need not be written in the Glossary.

It should be low as it only inconveniences a minority of users, as the use of a CLI assumes computing literacy, hence we expect users to know what is a "key" and what "authentication" means. We used "filter" as we already have a "find" command.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]