DFE-Digital / polis-whitelabel

:milky_way: Open Source AI for large scale open ended feedback
https://pol.is
GNU Affero General Public License v3.0
3 stars 0 forks source link

Error text improvements #17

Open brendanarnold opened 1 year ago

brendanarnold commented 1 year ago

From the October Accessibility report ...

You need to write in ‘Plain English’, don’t use uncommon words if possible. So your input warning of “Statement length exceeded by 1 characters” isn’t suitable, try changing it to “Too long, please make shorter by 1 character”.

Also any warnings need to come with advice on how to correct the issue, so the warning should be “Statement too long, please shorten before submitting”.

This relates to error messages in the statement submission, login and to the admin page inputs

patcon commented 1 year ago

I find this tool to be amaaaazing for supporting ppl to write accessible text: (top 1000 english words) https://splasho.com/upgoer5/

It's a little silly, but it's a neat constraint to have the individually add words to the list, and perhaps kinda negotiate the need for each. Storing the word lists in the repo itself might allow that conversation to occur in-flow of PR process :)

Screen Shot 2022-12-09 at 6 33 06 PM

BONUS: This could also be a CI linter, using the word list and a prose linting tool: https://splasho.com/upgoer5/phpspellcheck/dictionaries/1000.dicin http://proselint.com/

https://github.com/amperser/proselint/issues/1334