视频

视频指南

视频在 Docker 的文档中很少使用。当使用时，视频应补充书面文本，而不应是文档的唯一形式。视频的制作时间可能比书面文本甚至截图更长，维护也更困难，因此在添加视频之前请考虑以下几点：

• 您能否证明客户对使用视频有明确的需求？
• 视频是否提供新内容，而不是直接阅读或重新利用官方文档？
• 如果视频包含可能定期更改的用户界面，您是否有维护计划以保持视频的更新？
• 视频的语气和语调是否与文档的其余部分一致？
• 您是否考虑过其他选项，例如截图或澄清现有文档？
• 视频的质量是否与 Docker 文档的其余部分相似？
• 视频能否从网站链接或嵌入？

如果满足上述所有条件，您可以在创建视频以添加到 Docker 文档之前参考以下最佳实践。

最佳实践

• 确定视频的受众。视频是对初学者的广泛概述，还是针对高级用户的技术过程的深入探讨？
• 视频应少于 5 分钟。请记住视频需要多长时间才能正确解释主题，如果视频需要超过 5 分钟，请考虑使用文本、图表或截图代替。这些更容易让用户扫描相关信息。
• 视频应遵守与文档其余部分相同的可访问性标准。
• 通过编写脚本（如果有旁白）、确保不显示多个浏览器和 URL、模糊或裁剪任何敏感信息以及在不同浏览器或屏幕之间使用平滑过渡来确保视频质量。

视频不托管在 Docker 文档仓库中。要添加视频，您可以使用链接到托管内容，或使用iframe嵌入。

iframe

要在文档页面上嵌入视频，请使用 <iframe> 元素

<iframe
  class="border-0 w-full aspect-video mb-8"
  allow="fullscreen"
  title=""
  src=""
  ></iframe>

asciinema

asciinema 是一个用于录制终端会话的命令行工具。录制内容可以嵌入到文档网站上。这些类似于 console 代码块，但由于它们是可播放和可跳转的视频，在某些情况下，它们比静态代码块增加了另一层实用性。asciinema “视频”中的文本也可以复制，这使得它们更有用。

如果满足以下条件，请考虑使用 asciinema 录制：

• 终端命令的输入/输出对于静态示例来说太长（您也可以考虑截断输出）
• 您想展示的步骤可以通过几个命令轻松演示
• 查看命令的输入和输出都很有用

要创建 asciinema 录制并将其添加到文档中

1. 安装 asciinema CLI
2. 运行 asciinema auth 配置您的客户端并创建帐户
3. 使用 asciinema rec 开始新的录制
4. 运行演示的命令，然后使用 <C-d> 或 exit 停止录制
5. 将录制内容上传到 <asciinema.org>
6. 使用 <asciinema.org> 上的 Share 按钮，通过 <script> 标签嵌入播放器