跳至內容
Help centers and docs

當使用者介面變更時,如何保持說明文件更新

一套針對說明文章、截圖與教學影片的發布例行流程:螢幕清單、四種變更層級、負責人與截止日期,以及您可以自動化的項目。

Roozbeh Firoozmand閱讀時間 5 分鐘

更新於 2026 年 11 月 3 日

為了保持說明文件更新,請將其與您的發布流程掛鉤,而非進行年度大掃除。為每篇說明文章與影片標記其展示的螢幕,根據該清單檢視每次發布,將變更分類為四個層級,就地修正標籤,並僅重新錄製變更的流程。接著指定負責人,為每個層級設定截止日期,並衡量自上次發布以來,您的說明中心有多少內容已完成檢查。

本指南適用於產品每幾週就會變更的支援與客戶教育團隊。它涵蓋了文章、截圖與教學影片,因為一次發布會同時影響這三者。無論使用何種工具,相同的流程都能讓知識庫保持最新狀態。

為什麼過時的說明文件會堆積得這麼快?

說明內容描述的是介面,而介面在每個衝刺(sprint)中都會變更。以下三件事讓情況變得更糟:

  • 沒人及時得知變更。 發布說明寫著「改進設定導覽」;但文章仍寫著「開啟頂部選單」。
  • 更新速度趕不上發布速度。 如果修正影片意味著要找到原始創作者、重新錄製、重新剪輯並重新嵌入,那麼這件事就不會發生。
  • 副本不斷增加。 同一支影片可能存在於說明文章、新手引導郵件、LMS 課程與三種語言版本中。每一處都是可能過時的隱憂。

這是一個可量化的問題。當 Tella 在 2026 年 10 月審核其說明中心時,其 76 支說明文章影片中有 32 支(42%)已過時(供應商對自身內容的審核)。讀者也注意到了:在 Gartner 對 5,728 位客戶的調查中,只有 14% 的服務問題在自助服務中得到完全解決,而失敗最常見的原因(43%)是找不到與問題相關的內容。過時的文章加劇了這個問題:不再符合螢幕畫面的內容,等同於不存在。

成本由支援團隊承擔,因為客戶總是先嘗試查閱說明文件。哈佛商業評論在 2017 年報導指出,81% 的客戶在聯繫客服代表前,會先嘗試自行解決問題。過時的步驟往往會變成一張客服工單。更多數據請見我們的 客戶自助服務統計數據。

哪些基本原則能讓說明文件保持更新?

無論您使用什麼工具,四個習慣就能完成大部分工作:

  • 單一事實來源。 每個答案只存在於一篇文章中。其他頁面透過連結引用而非重複內容,因此變更只需編輯一次。
  • 說明文件納入「完成定義」(Definition of Done)。 功能未完成,直到其說明內容也已更新。在提取請求(pull-request)或發布檢查清單中加入說明文件項目,並指定檢查人員。
  • 每個頁面都有審核日期。 大多數說明中心工具都能顯示頁面的最後更新日期;根據風險設定審核日期(帳單與設定頁面每季一次,少用的設定每年一次),並標記過期的頁面。
  • 有目的地封存。 當功能移除時,封存其頁面並重新導向 URL,而不是讓它保持上線卻內容錯誤。

本指南的其餘部分是建立在這些習慣之上的發布例行流程。

如何找出發布內容導致哪些文章與影片過時?

文章標題清單無法告訴您發布內容破壞了什麼,但螢幕清單可以。為每篇文章或影片建立一個清單列,並使用您的產品團隊在工單與發布說明中使用的名稱(例如「帳單設定」、「邀請視窗」、「左側導覽」),標記它所展示的每個螢幕、頁面或元件。

欄位 發布當日的重要性
展示的螢幕 發布說明與內容之間的連結鍵
文字或旁白中提到的 UI 標籤 即使佈局未變,重新命名的按鈕也會導致文字不符
存放位置 託管連結、嵌入、下載的 MP4、LMS、郵件序列、應用程式內小工具
配對的文章或影片 必須隨之變更的另一半
語言 每個翻譯版本都是需要更新的副本
擷取方式 桌面錄影、AI 錄影指令、上傳、手動截圖
負責人與最後驗證日期 誰負責檢查,以及上次與即時產品相符的時間

在發布當日,對照「展示的螢幕」欄位閱讀發布說明(或標記為使用者導向的合併提取請求)。接著加入發布說明中遺漏的兩個簡易訊號:

  1. 在您的說明中心搜尋每個重新命名的標籤。 如果「工作區」(Workspace)變成了「團隊」(Team),請在文章與影片腳本中搜尋「工作區」。
  2. 在發布後的 14 天內監控工單。 諸如「影片顯示」、「我找不到按鈕」或「文章說」等短語,都指向了分類遺漏的內容。

「存放位置」欄位決定了更新的成本。從即時主機嵌入的影片可以就地變更。簡報檔或客戶新手引導資料夾中下載的 MP4 檔案不會自動更新,您必須手動替換每個副本。在下次發布前(而非發布期間)將這些內容移至託管連結或嵌入式播放器。

Clevera 的「分享影片」對話框中的「嵌入」標籤:即時播放器預覽、標題與詳細資訊以及章節開關,以及 HTML 嵌入程式碼(範例資料)
嵌入式播放器可以就地變更;下載的檔案則無法。

這是哪種變更?分為四個層級進行分類

分類流程:發布說明、將螢幕與清單對應、分類為四個變更層級,然後重新翻譯並標記為已驗證
一旦每個項目都標記了螢幕,分類只需幾分鐘。

每個受影響的項目都會落入四個層級之一,每個層級對文章與影片都有不同的修正方式。

層級 變更內容(範例) 文章修正方式 影片修正方式
0. 外觀 顏色、圖示、間距(按鈕變綠) 通常無需處理;註記即可 通常無需處理;註記即可
1. 標籤 用詞變更,位置相同(「工作區」變為「團隊」) 替換標籤,更換受影響的截圖 編輯旁白與螢幕文字
2. 佈局 步驟相同,位置移動(設定移至側邊欄) 更新截圖,編輯步驟 重新錄製受影響的片段
3. 流程 步驟新增、移除或重新排序(邀請現在需要角色) 重寫步驟 重新錄製並重寫腳本

兩條規則能確保分類的準確性。首先,根據讀者所見而非設計師的變更來判斷層級:如果舊標籤在畫面中清晰可見,請將其視為第 2 層級,因為僅編輯旁白會導致影片畫面與語音不符。其次,檢查功能旗標。如果新佈局僅向 20% 的帳戶推出,舊內容對 80% 的讀者來說仍然正確。請在推廣至所有使用者時更新,或發布兩個版本並說明適用對象。

當 UI 變更時,如何更新說明文章?

  • 第 1 層級: 搜尋舊標籤,替換它,並僅重新擷取顯示該標籤的截圖。
  • 第 2 與第 3 層級: 從新流程的實際操作中 重寫步驟,而不是修補舊文字,這樣步驟順序才會與讀者所見相符。如果您的工具可以 從錄影產生文章,請錄製一次新流程並重新產生文章,然後複製任何手寫筆記。

截圖過時得最快。三個習慣可以減少您需要重新擷取的次數:裁切至所討論的元素而非全視窗、避免使用帶有日期的範例資料,並省略讀者僅憑文字即可理解的步驟截圖。工程導向的團隊會更進一步,在 自動化 UI 測試中擷取說明文件截圖,確保每次建置都能產生最新的圖片。

如何在不重新錄製所有內容的情況下更新教學影片?

在大多數發布中,大部分變更都是標籤。這些是最便宜的修正方式,也是您的影片託管平台發揮作用的地方。

檢查您的託管平台支援哪些原地變更。 YouTube Studio 允許您修剪並裁切已發布的影片,同時保留其網址、觀看次數與留言,但若使用新素材則需要重新上傳並產生新網址。Vimeo 表示替換影片檔案可保留相同的連結與嵌入程式碼。Wistia 的替換媒體功能可保留嵌入內容,但會重新產生字幕。

編輯文字,而非像素。 如果您的旁白是由腳本產生,重新命名標籤只需修改一行腳本並重新產生語音即可。螢幕上的文字、標題卡與重點標示亦同。針對重新命名的按鈕,權宜之計是模糊舊標籤並覆蓋新名稱。請將此視為重新錄製前的過渡方案,而非最終修復。

將第 2 級與第 3 級影片拆解為短片段重新錄製。 每個影片處理一項任務,長度控制在 1 到 3 分鐘。當流程變更時,您只需重新錄製一個短影片,而不必重新製作十分鐘的導覽。

網頁應用程式重新錄製的成本:約 2 分鐘與 9 點數

Clevera 的 AI 對話自動錄製:起始頁面 app.acme.io/projects、要展示的步驟、登入選項以及「允許變更」(Allow changes) 開關(範例資料)
AI 對話錄製功能,顯示範例指令。您儲存的指令即為完整的重新錄製內容。

為了量化重新錄製的成本,我們於 2026 年 10 月在一個公開的示範應用程式 (TodoMVC) 上執行了 Clevera 的 AI 錄影機。指令包含三句話:新增三個已命名的待辦事項、標記其中一個為已完成,然後點擊「進行中」(Active) 篩選器。該段文字即為完整的重新錄製內容。將其儲存至您的清單中,發布當天只需再次貼上,僅編輯變更的步驟並開始執行即可。設定示範帳號與指令的步驟請參考如何自動錄製網頁應用程式示範。

Clevera 從該 AI 錄製內容製作的 0:40 教學影片,未經編輯。

該代理程式執行指令時未出現重試或錯誤點擊。錄製耗時約 78 秒,產生 0:40 的影片約需 50 秒。成本為 9 點數:5 點用於錄製分析,4 點用於製作教學影片。有兩點提醒:此價格為全新錄製,而非流程變更後的重寫;且代理程式在步驟間會暫停(人類約 20 秒完成的任務,錄影耗時 58 秒),因此在替換前請先觀看新的錄製內容。

那麼翻譯與已停用的功能該怎麼辦?

最後再進行翻譯。 請先確認英文文章與影片,再進行翻譯。翻譯草稿意味著您需要支付兩次翻譯與審核費用。如果您的產品 UI 本身已在地化,在英文 UI 錄製的素材在每部翻譯影片中都會顯示英文標籤;請根據市場需求決定這是否可接受。

停用,不要只是刪除。 當功能移除時,請封存其文章,將舊網址重新導向至最接近的現行頁面,並從「內容所在位置」的所有地方移除該影片。客戶已加入書籤的頁面若被刪除,會變成 404 錯誤並導致客服單增加。

誰該負責更新文件,頻率為何?

沒有負責人的流程最終會變回「問客服就好」。這種分工方式適用於 2 到 10 名接觸說明文件的團隊:

角色 職責 時間
發布負責人 (PM 或工程主管) 使用清單名稱列出發布說明中變更的畫面 發布前
文件負責人 (客服營運、賦能或技術寫作) 執行分類、指派修復、更新清單;對產品周邊的核心內容進行全面檢查 1 個工作天內;每季檢查一次
各產品領域內容負責人 第 1 級編輯、重新錄製、文章重寫 3 到 5 個工作天內
客服主管 標記歸咎於文件的客服單 持續進行,每週審核

每季檢查可補足分類遺漏的部分,例如在十二個地方變更的共用元件。請從瀏覽量最高的內容以及客服單連結的內容開始,因為這些內容會影響客服單數量。

如何衡量您的文件是否為最新狀態?

挑選兩到三個指標,並在每次發布後進行審核:

  • 自上次發布後已驗證: 「上次驗證」日期在最新發布之後的項目,除以該次發布涉及畫面的項目總數。目標是在一週內達到 100% 的第 2 級與第 3 級項目。
  • 修復天數: 從發布到修復上線的中位數天數,按級別計算。
  • 歸咎於文件的客服單: 發布後 14 天內被標記為「文章錯誤」或「影片過時」的客服單。若要將此與問題排除率連結,請參閱如何衡量客服單排除率。
  • 搜尋失敗與低評分: 搜尋無結果以及在變更頁面上投下「無幫助」的票數。我們的尋找說明中心內容缺口指南將說明如何處理這些問題。

可以自動保持文件更新嗎?

部分可以。您目前可以自動化的項目:

工作 通用選項 仍需人工處理的部分
注意到發布 每次發布時的 Webhook 或 CI 作業;變更日誌 RSS 訂閱 決定哪些發布對讀者重要
尋找受影響內容 搜尋重新命名的標籤;將畫面映射至文章 判斷變更程度
重新擷取螢幕截圖 UI 測試中擷取的螢幕截圖 選擇要展示的內容
修復文字 編輯步驟或旁白的 AI 草稿 根據產品檢查結果
重新錄製流程 重新執行已儲存指令的 AI 錄影機 在上線前觀看新的錄製內容

模式在各處皆相同:自動化產生草稿,人工進行審核。關於 GitHub、GitLab、Bitbucket 或變更日誌頁面上的逐步管線,請參閱如何在每次發布時自動更新文件。此清單中的任何內容都不應在未經審核的情況下發布給客戶,因為一份自信滿滿但錯誤的文章比過時的文章更糟糕。

Clevera 如何保持文件與影片為最新狀態

Clevera 是一個 AI 平台,能將螢幕錄影轉換為旁白教學影片、逐步說明文章以及託管在說明中心的頁面,支援 74 種語言。其四個部分對應上述流程:

  • LiveSync (所有方案)。 編輯已發布影片的旁白、螢幕文字、重點標示或模糊效果,每個顯示該影片的 Clevera 分享連結、嵌入內容與說明中心頁面都會播放新版本。下載的 MP4 檔案則保持不變。
  • 重新錄製。 使用 Mac、Windows 或 Linux 桌面應用程式錄製變更後的流程,或讓 AI 螢幕錄影機 根據您儲存在清單中的指令點擊公開的網頁應用程式。Clevera 會從新的錄製內容編寫腳本、旁白與對應文章,接著您只需再次翻譯完成的英文版本,每種語言費用為 3 到 10 點數(您自行新增的文字元素不會被翻譯;請參閱如何翻譯教學影片以獲取各語言的審核建議)。
  • Autopilot (Pro 與 Custom 方案)。 Autopilot 會監控 GitHub 儲存庫的發布或合併的 Pull Request,或是您的變更日誌頁面,並根據每次變更檢查說明中心的影片與文章。對於它完整讀取的每個項目,它會提出「仍正確」、文字修復或重新錄製變更畫面的建議(當您允許它存取您的應用程式時)。重新錄製的影片會以相同的連結取代舊影片。
  • AI 助理 (Pro 及以上方案)。 如果您的團隊使用 Claude Code、Cursor 或 ChatGPT,他們可以透過 Clevera 的 MCP 伺服器 更新 Clevera 文章並製作影片。
準備審核的 Autopilot 方案:勾選的行數並附帶原因與點數範圍,一行未勾選,以及一個「執行」(Run) 按鈕
每一行都會說明將變更的內容與可能產生的成本。在您點擊「執行」之前,不會有任何變更。

每次 Autopilot 執行都會等待您的審核:您可以取消勾選不想變更的項目並點擊 執行。觀看與規劃不消耗點數;一次典型的執行約消耗 10 到 150 點數。設定方式請參閱說明文章在發布時保持說明中心為最新狀態。

Clevera 不適用的情況:如果您的文件是從程式碼產生的 API 參考文件,那麼「文件即程式碼」(docs-as-code) 的流程會是更好的工具。此外,如果您的說明內容存放在其他您不打算更換的平台,Clevera 的影片與文章生成功能依然能提供協助,但 Autopilot 功能僅支援 Clevera 託管的說明中心與影片。

立即免費試用:免費方案包含託管說明中心以及長度不超過 3 分鐘的影片。若想了解建立說明中心的全貌,請參閱如何利用 AI 建立知識庫以及 Clevera 的說明中心軟體。如果您的產品已有 AI 助理可回答問題,那麼讓您的文件具備 AI 準備度就是下一步。

發布日檢查清單

將此清單複製到您的發布範本中。

  • 發布說明列出所有變更的畫面,並使用清單名稱
  • 已檢查功能旗標:記錄發布百分比;於 100% 時更新(或兩者皆發布)
  • 在所有文章與影片腳本中搜尋舊標籤
  • 每個受影響的項目標記為 L0 外觀、L1 標籤、L2 版面配置或 L3 流程
  • L1:替換標籤、重新截圖、編輯旁白與螢幕文字
  • L2/L3:重新錄製流程;重寫或重新生成文章步驟
  • 將新影片替換到所有連結、嵌入內容與小工具中
  • 找到並替換已下載的副本(LMS、簡報、電子郵件)
  • 確認英文內容,隨後重新執行翻譯
  • 更新清單:最後驗證日期、負責人、錄製說明
  • 在發布 14 天後審查與文件相關的支援票證

常見問題

文件應該多久更新一次?

在發布後的一週內審查受影響的內容,並每季全面檢視瀏覽量最高的文章與影片。對於每幾週就更新一次的產品來說,固定的年度審查速度太慢了。

誰應該負責保持文件更新?

由一位指定的文件負責人負責每次發布後的分類工作,並由各產品領域的內容負責人進行修正。發布負責人的工作是在發布前列出變更的畫面。若沒有這份清單,文件負責人只能盲目猜測。

每次 UI 變更時,我都必須重新錄製教學影片嗎?

不用。如果您的託管平台支援原地更新影片,且舊標籤在畫面中不明顯,您可以透過編輯旁白與螢幕文字來修正標籤變更。當版面配置或操作步驟變更時才需重新錄製,並保持影片簡短,確保變更只會影響單一片段。

如何找出過時的說明文章?

將發布說明與列出各文章所展示畫面的清單進行比對,搜尋已重新命名的標籤,並觀察發布後兩週內提及文件的支援票證。搜尋失敗與變更頁面上的「無幫助」投票也能協助找出其餘問題。