跳转到主要内容
TTS-1.5 is here: under 120ms latency, optimized stability!
Mintlify home page
简体中文
文档
指南
API 参考
更新日志
Get started
Get started
搜索...
搜索...
Navigation
最佳实践
媒体
人工智能
文档更新自动化
GEO
Claude Code
Cursor
Windsurf
API 文档
从 MDX 迁移到 OAS
最佳实践
无障碍
内容类型
改进你的文档
维护
媒体
组织导航
SEO(搜索引擎优化)
风格与语气
了解你的受众
Git
Git 概念
使用 branch 协作
在此页面
何时使用媒体
最佳实践
媒体
复制页面
加入媒体的指南
复制页面
本页介绍在文档中使用屏幕截图、GIF 和视频的最佳实践。
屏幕截图、GIF 和视频可以提升文档效果,但随着 UI 元素变化,它们需要持续维护。请有选择地使用,避免不必要的维护成本。
关键指南:
媒体应作为补充。
如果仅用文字就能清晰说明流程,请避免添加视觉元素。
确保无障碍性。
为图像添加替代文本、为视频添加字幕、为音频内容提供文字稿。许多人依赖辅助技术,而无障碍内容将惠及所有用户。
在清晰度与可维护性之间取得平衡。
频繁的 UI 变更会让截图和视频很快过时。衡量更新它们的投入是否与其带来的价值相匹配。
何时使用媒体
截图
:用于那些难以用文字清晰说明的任务。
GIF
:用于宣传推广,以及简短但流程复杂的演示。
视频
:用于解释抽象概念和较长的工作流程。
谨慎且有目的地使用媒体,以避免不必要的文档债务。使用得当时,它能在不增加维护负担或无障碍门槛的情况下提升理解。
此页面对您有帮助吗?
是
否
维护
组织导航
⌘I
助手
AI生成的回答可能包含错误。