Quality / How-to
Make documentation easier to access
Check structure, link labels, images, and instructions.
Give the page a useful structure
Use a descriptive page title and semantic headings that reflect the information hierarchy. A larger font alone does not make text a heading. Keep sections short enough for readers to scan and navigate.
Explain the destination and meaning
Write link labels that describe the destination. For informative images, provide text that conveys the information or function. Give complex diagrams a nearby explanation. Mark purely decorative images with an empty alternative when implementing HTML.
Make instructions independent of appearance
Name the control or field instead of relying only on its color or position. Explain required input formats. Provide captions and transcripts for instructional media as appropriate. Expand unfamiliar abbreviations and use clear language.
Verify with people and tools
Review keyboard navigation, focus visibility, zoom, and assistive-technology behavior alongside the content. W3C’s writing tips are a starting point; completing this writing checklist does not certify the entire site’s accessibility.
Sources & further reading
Original guidance and examples by TechWriter, informed by these resources.