mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
f8e015ff62
* Improve SEO metadata: update descriptions to 130-155 chars across 177 pages Generated-By: mintlify-agent * Apply suggestion from @ethanpalm * Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> * 💅 --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
26 lines
1.4 KiB
Plaintext
26 lines
1.4 KiB
Plaintext
---
|
|
title: "Media"
|
|
description: "Use images, screenshots, videos, and diagrams effectively in your documentation while managing file sizes and long-term maintenance costs."
|
|
keywords: ["screenshots", "GIFs", "videos", "media best practices"]
|
|
---
|
|
|
|
<Tip>
|
|
This page explains best practices for using screenshots, GIFs, and videos in your documentation.
|
|
</Tip>
|
|
|
|
Screenshots, GIFs, and videos can enhance documentation but require ongoing maintenance as UI elements change. Use them selectively to avoid unnecessary upkeep.
|
|
|
|
Key guidelines:
|
|
|
|
- **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. Many people use assistive technology and accessible content benefits 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.
|
|
|
|
## When to use media
|
|
|
|
* **Screenshots** for tasks that are difficult to explain with words.
|
|
* **GIFs** for promotional purposes and short yet complex workflows.
|
|
* **Videos** for abstract concepts and long workflows.
|
|
|
|
Use media sparingly and intentionally to avoid unnecessary documentation debt. When done right, it enhances comprehension without adding maintenance burdens or accessibility barriers.
|