影片

影片指南

Docker 文件中很少使用影片。使用時,影片應作為文字的補充,而不是唯一的文檔格式。影片的製作時間可能比文字甚至螢幕截圖更長,維護也更困難,因此在新增影片之前請考慮以下事項

  • 您可以證明使用影片有明確的客戶需求嗎?
  • 影片是否提供新的內容,而不是直接閱讀或重新利用官方文件?
  • 如果影片包含可能會定期變更的使用者介面,您是否有維護計畫來保持影片的最新狀態?
  • 影片的語氣和語調是否與其他文件的風格一致?
  • 您是否考慮過其他選項,例如螢幕截圖或釐清現有文件?
  • 影片的品質是否與其他 Docker 文件類似?
  • 影片可以從網站連結或嵌入嗎?

如果滿足以上所有條件,您可以在製作要新增到 Docker 文件的影片之前參考以下最佳實務。

最佳實務

  • 確定影片的目標對象。影片是針對初學者的廣泛概述,還是針對進階使用者設計的技術流程深入探討?
  • 影片應少於 5 分鐘。請記住影片需要多長時間才能正確說明主題,如果影片需要超過 5 分鐘,請考慮改用文字、圖表或螢幕截圖。使用者更容易瀏覽這些內容以找到相關資訊。
  • 影片應遵循與其他文件相同的無障礙標準。
  • 透過撰寫腳本(如有旁白)、確保多個瀏覽器和網址不可見、模糊或裁剪任何敏感資訊,以及在不同瀏覽器或螢幕之間使用平滑的轉場效果,來確保影片的品質。

影片未託管在 Docker 文件庫中。要新增影片,您可以使用連結到託管的內容,或使用iframe嵌入。

iframe

若要在文件頁面上嵌入影片,請使用 <iframe> 元素

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

asciinema

asciinema 是一個用於錄製終端機工作階段的命令列工具。錄製內容可以嵌入到文件網站中。這些類似於 console 程式碼區塊,但由於它們是可播放和可 scrubbing 的影片,因此在某些情況下,它們比靜態程式碼區塊更有用。asciinema「影片」中的文字也可以複製,這使得它們更有用。

如果符合以下情況,請考慮使用 asciinema 錄製

  • 終端機命令的輸入/輸出對於靜態範例來說太長(您也可以考慮截斷輸出)
  • 您想要顯示的步驟可以透過幾個命令輕鬆示範
  • 在查看命令的輸入和輸出時很有用

要建立 asciinema 錄製並將其新增到文件中

  1. 安裝

    編輯此頁面

    要求變更