Practice Makes Perfect: Write Accessible Documentation
summary
Gives six concrete edits that make documentation actually usable: swap imprecise UI verbs for turn on/turn off and replace blacklist/whitelist with deny list/allow list; rewrite ambiguous error text into clear action-first sentences; add step-by-step Chrome DevTools instructions when examples target Chrome; avoid color-only cues and never use click here as link text; keep concise copy; put descriptive alt text beside screenshots rather than repeating instructions in the image. Backed by testing with screen readers and population figures (4.13B internet users, ~1B with visual issues, 19% cognitive).
AI-written summary · about
chapters (12)
- 0:00Start
- 6:41Avoid Colloquialisms
- 7:47Tip 2 Write Clear Instructions
- 9:31Testing Examples
- 10:02User Agent Reduction
- 11:20Tip 3 Reduce Visual Cues
- 12:01Ingredients for a Salad
- 13:08Tip Four
- 16:50Tip 5 Write Valuable Alt Text
- 17:39General Best Practices
- 19:36Tip 6 Is the Secret to Good Documentation Keep Your Content Concise
- 24:37Semantic Html
related talks
51mTechnically speaking improve your code documentation
48mBeyond Words: Crafting User-Friendly Documentation
35mAccessibility (when you don't have time to read the manual)
05mMake your website accessible for everyone
38mA11y-Friendly Documentation
33mDocumentation: The Missing Pieces
01h 24mWriting Documentation - Practices and Theory
28mImproving Your Documentation: A talk for developers who want to write stuff good