影片

目錄

影片指南

影片在 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> 上的 Share 按鈕，透過 <script> 標籤嵌入播放器