This article covers guidelines for how to use screenshots, GIFs, and videos in your documentation.
- Media should be supplementary. If a workflow is clear in text alone, avoid adding visuals.
- Ensure accessibility. Add alt text for images, subtitles for videos, and transcripts for audio content. Over 2 billion people use assistive technology, and accessibility features benefit all users.
- Balance clarity with maintainability. Frequent UI changes can make screenshots and videos outdated quickly. Consider whether the effort to update them is worth the value they add.
Media Type | When to use | Example | Time |
---|---|---|---|
Screenshots | For tasks that are difficult to explain with words | UI element (such as a button or dropdown) is hidden or obscure | ~5 min |
GIFs | For promotional purposes and short yet complex workflows | Product changelog | ~1 hour |
Videos | For abstract concepts and long workflows | Tutorials | Several hours |