Accessibility

Write documentation that readers can understand and move through, on any device and with any assistive technology.

• Use descriptive link text. See Links.
• Go from H2 to H3 to H4 without skipping a level. See Headings and article structure.
• Convey meaning with more than color alone.
• Add useful alt text to images. See Screenshots and images.
• Add captions or transcripts to video and audio, and give key information in more than one format.
• Make sure text and other visual elements have enough color contrast.
• Give readers only the information and choices they need. See Writing principles.
• Keep tables simple and understandable.
• Make sure screenshots stay readable when zoomed.
• Give key information in text as well as in images.
• Avoid directional references when the UI element can be identified by name. See Writing procedures and UI instructions.
• Use inclusive language. See Terminology.
• Put the most important information first, and group related content under clear headings.
• Avoid all caps for emphasis and camel case in ordinary text, because screen readers might read the letters one by one. Acronyms and code are fine.
• Tell readers when a link opens a new tab or downloads a file. See Links.
• Introduce each table in the text before it, and avoid merged cells. See Formatting conventions.
• Avoid images of text or code. See Screenshots and images.