dayn-1 / pe

0 stars 0 forks source link

Confusing terms for the target audience #12

Open dayn-1 opened 7 months ago

dayn-1 commented 7 months ago

In the User Guide, the description of the constraints for tag is defined as such:

image.png

The primary school tutor is unlikely able to understand what this syntax "[a-zA-Z0-9]" means.

soc-se-bot commented 7 months ago

Team's Response

Target users are stated to be familiar with CLI apps and would be tech-savvy and familiar with the syntax.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I think being "reasonably comfortable using CLI apps", as seen in the screenshot, does not imply that the target user is of a strictly technical background and capable of understanding the code syntax. Rather, the comfortability is with regards to the use of commands to execute actions, rather than mouse-clicks.

Frankly, it also took me awhile to understand how to read this REGEX expression. Therefore, I do think that the UG should avoid using such syntax to reduce overall complications.