视频

目录

视频指南

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> 上的“分享”按钮，通过 <script> 标签嵌入播放器
页面选项