跳至內容
Clevera 說明中心

在發布更新時保持說明中心同步

「在發布更新時保持說明中心同步」會監控一個儲存庫、更新日誌頁面或你描述的單一變更。每當有變更時，Clevera 就會檢查你說明中心的影片和篇文章，並規劃出需要你核准的修正內容。在你點擊「執行」之前，不會有任何變更。

更新於 閱讀時間 3 分鐘

在發布更新時保持說明中心同步是一項 Autopilot 配方，能讓說明中心與你的產品保持一致。它會監控變更出現的位置：儲存庫的發布或已合併的變更、更新日誌頁面，或是你描述的單一變更。每當有變更時，Clevera 就會讀取說明中心受影響的影片和篇文章，判斷每一項的需求，並規劃修正內容。在你核准該計畫之前，不會有任何變更。

若要在沒有說明中心的情況下保持影片為最新狀態，請改用在產品變更時更新我的影片。

開始之前

  • 一個說明中心。 如果沒有說明中心，代理程式會說「這需要先有一個說明中心」，且卡片會顯示「這適用於說明中心，但此工作區尚未建立。請先建立一個，然後再進行此設定。」並附上建立我的說明中心，這會在同一個對話中開啟該配方。請參閱從你的應用程式建立說明中心。
  • 你的角色。 你需要一個可以建立內容的角色。若要更新影片，你還需要擁有編輯影片的權限；若要更新篇文章，則需要編輯說明中心頁面的權限。
  • 一個儲存庫，用於追蹤發布。 擁有者或管理員需先連接 GitHub，並在連接下允許該儲存庫。請參閱連接一個儲存庫。更新日誌頁面或你描述的變更則無需連接。
  • 你的應用程式網址和登入資訊，用於重新錄製變更的畫面（選用）。請參閱儲存應用程式登入資訊。

進行設定

  1. 開啟配方

    在連接中，點擊在發布更新時保持說明中心同步（位於或從配方開始下方），或在Autopilot 應該做什麼？中提出要求，例如「每次我們發布更新時，更新說明中心」。代理程式面板會開啟設定卡片，並顯示已填入內容的摘要：時間、說明中心、檢查和觀看。

    代理程式面板顯示「在發布更新時保持說明中心同步」設定卡片，包含「時間：每次發布」、「說明中心：Acme Help」、「檢查：影片和篇文章」以及「觀看」列
    若有連接儲存庫，卡片會從「每次發布」開始。

  2. 填寫詳細資訊

    點擊詳細資訊（或在填寫完所有必要項目後點擊編輯詳細資訊）。選擇執行時間、說明中心和監控對象，並決定是否允許 Clevera 使用你的應用程式。請參閱設定表單。點擊繼續。

    「在發布更新時保持說明中心同步」表單對話框，將「執行」設為「每次發布」，並選取說明中心、「檢查」、「觀看」（包含儲存庫和發布選項）、「詳細資訊」和「你的應用程式」
    「執行」和「觀看」會同步變動：選擇「每次發布」對應「一個儲存庫」，「更新日誌頁面」對應該頁面，「僅此一次」對應「僅此變更」。

  3. 檢查審閱並建立任務

    審查顯示了 時間（「每次發布後」、「每次已合併的變更後」、「每天檢查頁面」、「每週檢查頁面」或「立即執行一次」）、核准（「每次執行皆需等待您的審查」）、典型執行（「10–150 點數」）以及 語言（按名稱，例如「英語 (美國)」）。點擊 建立任務。

  4. 等待第一次變更

    監控任務不會立即執行。它會顯示啟用中和尚未執行：「自設定以來尚未發生任何變更。第一次執行將在變更發生時規劃。」在 Autopilot 首頁上，它會列在永遠開啟下方，並帶有監控中標籤。若選擇立即執行一次，Clevera 會直接規劃修正內容。

    一個「保持 Acme Help 為最新」的任務頁面，標記為「啟用中」，顯示「尚未執行」，且「保持最新」卡片顯示儲存庫、上次檢查時間和下次檢查時間
    「保持最新」卡片會顯示監控對象及下次檢查時間。

設定表單

區段 欄位 選項與預設值
時間 執行 每次發布（預設）、一個更新日誌頁面或立即執行一次。前兩者會顯示「目前不會執行。每次觸發時，Clevera 會規劃一次執行，並在製作任何內容前等待你的審閱。」
說明中心 說明中心 當你只有一個說明中心時會自動選取（「你唯一的說明中心」）。僅會檢查其頁面以及製作這些頁面所用的影片。
檢查 影片和篇文章（預設）、篇文章或影片
監控對象 觀看 一個儲存庫（「讀取其發布或合併的變更。」）、一個更新日誌頁面（「每日或每週讀取你的發布說明。」）或僅此變更（「用你自己的話描述它。檢查一次。」）。變更此選項會同步變更「執行」選項，反之亦然。
連接與儲存庫（一個儲存庫） 會選取你的第一個連接與儲存庫。允許更多儲存庫會開啟「連接」。
讀取（一個儲存庫） 發布（預設）：「你發布的每次更新。」已合併的變更：「每次合併的提取請求。」
更新日誌頁面（一個更新日誌頁面） 你的發布說明或更新日誌的網址。每次檢查時都會讀取。
檢查（一個更新日誌頁面） 每日（「每天讀取一次。」）或每週（預設，「每週讀取一次。」）
詳細資訊 變更內容（僅限「僅此變更」） 必填。最多 5,000 個字元，例如「設定移至帳戶選單中」。
Clevera 有什麼需要注意的嗎？（選用） 最多 2,000 個字元。每次執行都會讀取，例如「在每篇文章中提及版本號」。
你的應用程式 你的應用程式 使用我的應用程式：「重新查看並錄製變更的畫面。」不使用我的應用程式：「僅更新篇文章和影片的文字。」你必須選擇一項。
應用程式網址與登入資訊（使用我的應用程式） 網址預設為你品牌的網站。登入資訊的操作方式與所有 Autopilot 表單相同：使用登入資訊或我的產品不需要登入資訊。

此任務沒有預算和核准選項：此任務的每次執行皆需等待你的審閱。

檢查頻率

監控 任務排程時間
一個儲存庫、發布 新發布後。儲存庫大約每小時檢查一次。
一個儲存庫、已合併的變更 合併提取請求 (pull request) 後。大約每小時檢查一次。
變更日誌頁面 當頁面顯示新內容時。根據您的選擇，每天或每週讀取一次；任務頁面會顯示為 每天 或 每週。稍後，在 保持最新狀態 卡片上點擊 編輯，也會提供 每兩週 和 每個月 的選項。
僅此變更 建立任務後立即執行一次

Clevera 只會讀取發布說明以及提取請求的標題和文字，絕不會讀取你的程式碼。當一次執行正在等待你或正在進行時，新的變更不會啟動第二次執行：下一次執行會涵蓋所有變更。如果計畫在等待你時又有新變更進來，提醒訊息會說明，例如「自上次以來又有一項發布或合併變更」。

每次執行的內容

  1. 讀取變更。 自上次執行以來的發布說明、已合併的變更或更新日誌條目，或是你提供的文字。
  2. 找出受影響的項目。 它會檢查你可以編輯的說明中心影片和篇文章，每次執行最多 40 項。超過此數量的項目會列在計畫中：「還有 2 項可能受影響：每次任務最多編輯 40 項。」
  3. 完整讀取每個受影響的項目並判斷其需求：
判定 計畫建議
仍然正確 無。計畫會說明已完整檢查多少項目且仍然正確。
文字修正 文章的新文字，或影片的旁白和標題，顯示為「前 → 後」
重新錄製 影片以新步驟重新錄製（需要使用我的應用程式）。新錄製內容會取代說明中心頁面及其公開連結上的舊內容。
  1. 發現新功能。 使用使用我的應用程式時，尚未被涵蓋的功能會列為選用的新影片，且未勾選：「一項新功能可以製作專屬影片（未選取）。」

透過你的應用程式，Clevera 只會重新探索變更的區域，因此未變更的畫面不會重新錄製。若沒有使用應用程式，需要錄製的行會顯示「若要重新錄製，請使用你的應用程式網址和登入資訊重新啟動此任務。」

當執行結果顯示無需變更時，任務會以完成結束，並顯示「這次無需任何變更。」且不會通知你。

審閱並執行計畫

每個計畫都會在需要你下方等待，當準備好時，你設定任務的對話視窗會收到訊息。現有內容的修正會預設勾選；新功能的影片則不會勾選。每一行都會顯示其點數。取消勾選你不想要的項目並點擊執行，或點擊要求修改以取得新計畫。文章修正會儲存為文章的新修訂版本；已完成的修正行可透過復原來還原。

費用

監控、檢查和規劃皆為免費。每個修正項目在執行前都會在計畫行顯示其點數，你只需為實際使用的內容付費。典型執行費用為 10–150 點數，需時 5–90 分鐘：文字修正僅需少量點數，重新錄製畫面則需較多點數。

變更、暫停或停止任務

在任務頁面上，保持最新狀態 卡片具有 暫停 / 繼續、編輯 和 刪除 功能。變更 會開啟代理程式，它會提供修改任務每次執行的內容或預算，或是暫停任務或立即執行。啟動任務的條件（儲存庫、變更日誌頁面）無法更改：代理程式會建議您使用新的觸發條件設定新任務，然後再刪除此任務。請參閱 變更 Autopilot 任務。

疑難排解

您看到的內容 處理方式
"This one needs a help center first." 點擊建立我的說明中心，或選擇其他方案。
"Pick a help center." 選擇要保持最新狀態的說明中心。
"No repository is allowed yet. Connect an account and choose the repositories Autopilot may read." 點擊開放連線、進行連接並允許該儲存庫。或者監控變更日誌頁面。
"Connect a repository first." 同上：目前尚未允許 Autopilot 使用任何儲存庫。
"Pick a repository." / "Pick a repository selected on one of this workspace’s connections." 選擇一個儲存庫，或在連接下允許更多儲存庫。
"Add the changelog page’s address." 填寫變更日誌頁面。
"Describe what changed." 僅此變更需要變更內容。
"Choose whether Clevera may use your app." 選擇使用我的應用程式或不使用我的應用程式。
"This task can’t be started that way. Pick one of the choices under When." 選擇執行選項中的其中一項。
"Your role can’t edit videos in this workspace, so this task can’t update them." 將檢查設定為篇文章，或要求具備可編輯影片權限的角色。此訊息也適用於文章。
"None of these changes affects your videos or articles." 這次無需修正任何項目。
"Some items could not be checked. Ask for changes to check them again." 點擊計畫上的要求修改。
The task shows Paused: connection 儲存庫連線已停止運作。請在連接下重新連接，然後繼續執行。
連接儲存庫讓 Autopilot 讀取發行版本與合併的變更。當產品變更時更新我的影片同上，適用於沒有說明中心的影片。儲存應用程式登入資訊讓 Clevera 再次記錄您的應用程式。變更 Autopilot 任務暫停、繼續、編輯或刪除任務。