视频

视频指南

Docker 的文档中很少使用视频。使用时，视频应补充书面文本，而不是文档的唯一格式。与书面文本甚至屏幕截图相比，视频的制作时间可能更长，并且更难以维护，因此在添加视频之前请考虑以下事项：

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

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

最佳实践

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

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

内嵌框架

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

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

腹膜虫

asciinema是一个用于记录终端会话的命令行工具。录音可以嵌入到文档站点中。它们与代码块类似 console，但由于它们是可播放和可擦洗的视频，因此在某些情况下它们比静态代码块增加了另一个级别的有用性。 “视频”中的文本asciinema也可以复制，这使得它们更有用。

如果出现以下情况，请考虑使用asciinema录音：

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

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

安装命令asciinema行界面
运行asciinema auth以配置您的客户端并创建帐户
开始新的录音asciinema rec
运行演示命令并使用<C-d>或停止录制exit
将录音上传到 <asciinema.org>
<script>使用<asciinema.org> 上的“共享”按钮为播放器嵌入标签