Skip to content

Instantly share code, notes, and snippets.

@brianteeman
Last active February 6, 2018 17:58
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save brianteeman/f7ec725b9e74539f4684be91859fcde2 to your computer and use it in GitHub Desktop.
Save brianteeman/f7ec725b9e74539f4684be91859fcde2 to your computer and use it in GitHub Desktop.
WCAG 2.1 - Understandable

https://www.w3.org/TR/WCAG21/#understandable

Information and the operation of user interface must be understandable.

Guideline 3.1 Readable

Make text content readable and understandable.

Word choice: use the simplest word that conveys your meaning. [1] Prefer the short word to the long. [2]

Examples of changes to Jooomla language strings

BEFORE

"Alternatively, you can scan the following QR code in Google Authenticator."

AFTER

"Or, you can scan the QR code in Google Authenticator."

BEFORE

"The indexer is being initialised. Do not close this window."

AFTER

The indexer is starting. Do not close this window."

RESOURCES

https://www.plainlanguage.gov/guidelines/words/use-simple-words-phrases/

https://en.wikipedia.org/wiki/List_of_plain_English_words_and_phrases

REFERENCES

[1] http://plainlanguagenetwork.org/plain-language/what-is-plain-language/ [2] https://www.plainlanguage.gov/guidelines/words/

@fuzzbomb
Copy link

fuzzbomb commented Feb 5, 2018

You're on the right track!

GOOD: alternatively => or
GOOD: omitting the word "following" - I take it there's only one QR code being shown.
GOOD: is being initialized => is starting. Cringe, that was horrible.

Keep iterating. I'm not sure of the exact context, but maybe...

The indexer is starting. => Updating the index. (This is a good candidate for a symbol too, like a progress bar or spining wheel. Is there a "finished" message?)

@brianteeman
Copy link
Author

related pr for my own reference
19310 "select" not "click"
18852 remove "just"
14607 remove "successfully"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment