Guidelines for incorporating media
This article covers guidelines for how to use screenshots, GIFs, and videos in your documentation.
Screenshots, GIFs, and videos can enhance documentation but require ongoing maintenance as UI elements change. Use them selectively to avoid unnecessary upkeep.
Key guidelines:
The following table contains media guidelines & time required to update, courtesy of Idan Englander, Manager of Technical Writing at Anaconda:
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 |
Use media sparingly and intentionally to avoid unnecessary documentation debt. When done right, it enhances comprehension without adding maintenance burdens or accessibility barriers.