開源貢獻者的螢幕錄影指南

開源貢獻變得越來越視覺化。螢幕錄影能讓維護者更快理解你的變更、讓 Bug 回報無懈可擊，也能為你的 Pull Request 提供充分的說明脈絡。無論你是第一次參與貢獻，還是經驗豐富的維護者，以下是如何用 Recorded 提升開源工作流程的方法。

為什麼螢幕錄影在開源中如此重要

文字描述的表達能力有其極限。一段 30 秒的螢幕錄影，往往勝過長篇大論的文字說明，能清楚呈現你所看到的問題、嘗試過的方法，以及修復方案的實際效果。

開源維護者每週要審查數十個 Issue 和 PR。一段清晰的影片示範，能讓你的提交脫穎而出，更快獲得合併。

錄製能被有效處理的 Bug 回報

作為回報者，最有效的做法就是直接展示 Bug 發生的過程。影片形式的 Bug 回報可以：

• 消除歧義：維護者能看到你所看到的一切
• 加速分類：無需來回詢問重現步驟
• 證明可重現性：說明這個 Bug 並非偶發現象

如何錄製優質的 Bug 回報

1. 完整捕捉情境：在觸發 Bug 之前就開始錄製，讓維護者了解前置設定
2. 善用縮放功能：用 Recorded 的縮放功能標示出問題的 UI 元素或錯誤訊息
3. 納入主控台：在 UI 畫面旁同步顯示瀏覽器開發工具或終端機輸出
4. 保持簡短：30 至 90 秒最為理想，用編輯器剪掉不必要的空白片段

用影片展示 Pull Request

在 PR 描述中附上修改前後的螢幕錄影，能大幅提升審查信心。維護者無需在本地拉取分支，就能看到你的改動確實有效。

PR 示範影片應涵蓋的內容

• 問題呈現：簡短展示原本的問題行為（10 至 15 秒）
• 修復成果：清楚示範修復後的正確行為
• 邊緣案例：展示相鄰功能仍能正常運作
• 程式碼說明（選用）：瀏覽編輯器中的關鍵變更

分段錄製各部分，並用 Recorded 的剪裁工具將片段流暢銜接。

建立專案文件與操作說明

若你是開源專案的維護者，製作影片文件將帶來長遠效益。新貢獻者能更快上手，常見問題也不會在 Issue 中反覆出現。

高價值的文件影片

• 快速入門：從 clone 到啟動應用程式的 2 至 3 分鐘流程說明
• 架構概覽：搭配旁白，逐一介紹程式碼庫的目錄結構
• 貢獻指南：示範如何執行測試、格式化程式碼，以及開啟 PR
• 功能示範：在 README 中為每項主要功能附上簡短錄影

將這些影片上傳至專案的 GitHub Releases、Wiki，或在 README 中連結專屬的 YouTube 頻道。

錄製程式碼審查

非同步影片程式碼審查在分散式團隊中越來越普遍。與其撰寫大量行內留言，不如邊瀏覽差異比對，邊錄製螢幕畫面。

影片程式碼審查的優點：

• 語氣更清晰（不會因文字被誤解為嚴厲）
• 能在說話的同時指向特定程式碼行
• 審查者能在更短時間內涵蓋更多內容

善用 Recorded 的游標高亮功能，讓觀看者清楚跟隨你指向的位置。

開源螢幕錄影的實用技巧

保持影片簡短：開源維護者都是志願貢獻者，時間有限。Bug 回報盡量控制在 2 分鐘以內，PR 示範則不超過 3 分鐘。

使用乾淨的環境：關閉不相關的分頁和應用程式，使用專用的瀏覽器設定檔進行錄製。

加入文字標注：使用 Recorded 的文字疊加功能，為各段落加上「修改前」、「修改後」或「Bug」、「已修復」等標籤。

簡單的 Bug 可匯出為 GIF：對於短暫循環的 UI 問題，直接在 Issue 中嵌入 GIF 比影片更易於快速瀏覽。

選擇合適的托管方式：GitHub Issues 和 PR 支援直接上傳影片。較長的文件影片則適合使用 YouTube 未列出連結分享。

立即開始

開啟 Recorded，選擇「視窗擷取」模式，只錄製你的瀏覽器或程式碼編輯器。啟用麥克風進行旁白說明，然後按下錄製。錄製完成後，剪掉多餘的空白片段，加入縮放效果突顯關鍵時刻，最後匯出即可。

你的下一份 Bug 回報或 PR，將會不言自明。