视频
目录
视频指南
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
录制并将其添加到文档中:
- 安装
asciinema
CLI - 运行
asciinema auth
以配置客户端并创建帐户 - 使用
asciinema rec
开始新的录制 - 运行演示命令并使用
<C-d>
或exit
停止录制 - 将录制上传到<asciinema.org>
- 使用<asciinema.org>上的**分享**按钮使用
<script>
标签嵌入播放器