Provide Definitions for Unusual Words, Jargon, and Idioms
Why It Matters
Words used outside their typical meaning, specialized jargon, or idiomatic expressions can be confusing for users with cognitive disabilities, learning disabilities, or those who are non-native speakers. Providing definitions or explanations makes the content more understandable.
Fixing the Issue
Identify unusual words, jargon, or idioms. Provide definitions or explanations through one of these methods:
- Include the definition directly in the text the first time the term is used.
- Link the term to a glossary page or definition popup.
- Use the <dfn> tag for the first instance and provide the definition nearby or use <abbr> with a title attribute for abbreviations/acronyms (though see WCAG 3.1.4).
- Provide a glossary section on the website.
Good Code Example
Providing definitions using inline links or <dfn>:
-
<p> Our new system uses <dfn>AJAX</dfn> (Asynchronous JavaScript and XML) to update content dynamically. This provides a better user experience, but be careful not to <a href="https://dictionary.cambridge.org/us/dictionary/english/bite-off-more-than-can-chew" title="Definition of 'bite off more than you can chew'" target="_blank" rel="noopener noreferrer">bite off more than you can chew</a> during development. <p>Please consult the <abbr title="World Wide Web Consortium">W3C</abbr> standards.</p></p>
-
Our new system uses AJAX (Asynchronous JavaScript and XML) to update content dynamically. This provides a better user experience, but be careful not to bite off more than you can chew during development.
Please consult the W3C standards.
Bad Code Example
Using jargon or idioms without explanation:
-
<p> To optimize the UX, we leveraged a bespoke middleware solution. The stakeholders wanted to hit the ground running, so we skipped some UAT. </p>
-
To optimize the UX, we leveraged a bespoke middleware solution. The stakeholders wanted to hit the ground running, so we skipped some UAT.
