Write documentation that is accessible not only to people with disabilities but also to an international audience and those who use older technology and different browsers.
Most of the principles that apply to good technical documentation also apply to accessible technical documentation.
- Use correct grammar and punctuation.
- Use active voice and present tense.
- Write clear, simple sentences.
- Be consistent.
- Avoid colloquialisms, jargon, slang, and the like.
- Beware of dangling modifiers.
- Use the relative pronoun
thatwhere you might otherwise omit it.
- Avoid ambiguous pronouns.
- Use the same terms everywhere, in both the documentation and the interface.
- Avoid abbreviations.
- Don’t say “left” and “right”.
- Avoid words with connotations e.g. ‘abort’, ‘master’, ‘disable’.
- Use the simplest terminology.
- Use words with the fewest meanings.