mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
bced9bd6c4
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
27 lines
1.3 KiB
Plaintext
27 lines
1.3 KiB
Plaintext
---
|
|
title: "媒体"
|
|
description: "在控制维护负担的同时高效使用媒体。"
|
|
keywords: ["截图", "GIF", "视频", "媒体最佳实践"]
|
|
---
|
|
|
|
<Tip>
|
|
本页介绍在文档中使用截图、GIF 和视频的最佳实践。
|
|
</Tip>
|
|
|
|
截图、GIF 和视频可以增强文档效果，但随着 UI 元素变化，它们也需要持续维护。请有选择地使用，以避免不必要的维护工作。
|
|
|
|
关键原则：
|
|
|
|
- **媒体应起到补充作用。** 如果仅用文字就能清晰说明流程，就应避免再添加视觉元素。
|
|
- **确保无障碍可访问性。** 为图片添加 alt 文本，为视频添加字幕，为音频内容提供文字稿。很多人会使用辅助技术，而无障碍内容能惠及所有用户。
|
|
- **在清晰度与可维护性之间取得平衡。** 频繁的 UI 变更会让截图和视频很快过时。请评估更新它们所需的投入，是否值得它们带来的价值。
|
|
|
|
<div id="when-to-use-media">
|
|
## 何时使用媒体
|
|
</div>
|
|
|
|
* **截图**：用于那些难以用文字清晰说明的任务。
|
|
* **GIF**：用于宣传推广，以及简短但流程复杂的演示。
|
|
* **视频**：用于解释抽象概念和较长的工作流程。
|
|
|
|
谨慎且有目的地使用媒体，以避免不必要的文档债务。使用得当时，它能在不增加维护负担或无障碍门槛的情况下提升理解。 |