跳至內容
AI and agents

如何透過 Claude Code 在每次發布後更新說明文件

透過 Claude Code 更新說明文件:每次發布後,它會讀取更新內容、在 Clevera 中草擬更新日誌條目、標記需要修正的說明文章,最後由您發布。

Roozbeh Firoozmand閱讀時間 3 分鐘

程式碼在週二發布。如果有人記得的話,更新日誌會在週五撰寫,而變更畫面的說明文章往往會錯誤一個月。您可以改用 Claude Code 來更新說明文件:它已經在儲存庫中,因此知道發布了哪些內容。

本指南透過 Clevera MCP 伺服器將 Claude Code 連接到 Clevera 文件網站。每次發布後,Claude Code 會讀取 git log、草擬更新日誌條目、找出受影響的說明文章並提出編輯建議。由專人審核並發布。不會有任何內容在未經確認的情況下直接發布給讀者。

您首先需要準備什麼

一個 Clevera 文件網站。 文件網站是 Clevera 託管的 說明中心,內建更新日誌和 RSS 訂閱。每個方案都包含一個。

Pro 或更高版本。 AI 代理與 API 功能適用於 Pro 及更高版本。Pro 方案為每年支付 86.80 美元/月(每月支付則為 124 美元),包含 2 位創作者,每月享有 4,000 點共享點數。API 呼叫本身不消耗點數。請參閱 定價。

在您發布的儲存庫中安裝 Claude Code。 它需要執行 git log,若您希望它讀取合併請求 (pull request) 標題,則需執行 gh。

第 1 步:建立 Writer 權杖 (Token)

Clevera 的新 API 權杖精靈在「用途」步驟,選擇了「Docs writer (Claude Code)」權杖名稱的 Writer 預設設定

1. 在 Clevera 中,開啟工作區選單並選擇 AI agents & API,然後點選 Tokens 和 New token。2. 命名為 ("Docs writer (Claude Code)") 並選擇 Writer 預設設定:「代理進行草擬;由專人審核並發布。」它擁有 4 項權限:讀取內容、撰寫文章草稿、撰寫更新日誌草稿以及上傳圖片。3. 在 Limits 中,選擇 Doc sites 下的文件網站並設定過期時間。權杖總會過期,可選擇 7 天、30 天、90 天或 1 年後過期。4. 在 Review 中,點擊 Create token 並複製它。Clevera 只會顯示一次。請將其放入名為 CLEVERA_TOKEN 的環境變數中,切勿放入儲存庫。

為什麼選擇 Writer 而不是 Publisher?Writer 權杖無法變更讀者看到的內容。它無法發布,也無法編輯已經上線的文章。第二個限制決定了整個工作流程,因此將在第 3 步中說明。

第 2 步:連接 Claude Code

Clevera 的權杖建立對話框,包含現成的 Claude Code 設定指令(範例權杖)

在您的終端機執行此指令:

claude mcp add --transport http clevera https://app.clevera.ai/mcp --header "Authorization: Bearer $CLEVERA_TOKEN"

這會為您在當前專案中新增伺服器。如果整個團隊都需要使用,請改為將其新增至儲存庫根目錄的 .mcp.json 中。Claude Code 會展開該檔案中的 ${VAR},因此權杖本身不會被納入 git:

{ "mcpServers": { "clevera": { "type": "http", "url": "https://app.clevera.ai/mcp", "headers": { "Authorization": "Bearer ${CLEVERA_TOKEN}" } } } }

每位團隊成員隨後將 CLEVERA_TOKEN 設定為他們自己的權杖。Claude Code 在首次使用專案伺服器前會進行詢問。輸入 /mcp 或執行 claude mcp list 以檢查是否已連線。詳細資訊請參閱 Claude Code 的 MCP 文件,完整的權杖操作指南請參閱我們關於 透過 MCP 使用 Claude 製作影片 的指南。

第 3 步:要求更新發布文件

標記發布版本,然後給 Claude Code 一個提示詞。以下是一個您可以參考的範例:

> "我們標記了 v2.4。請讀取自 v2.3 以來的提交紀錄與 PR 標題。在我們的 Clevera 文件網站上,檢查更新日誌以避免重複條目,然後為 v2.4 草擬一個包含「新增」、「改進」與「修正」的條目。接著搜尋網站中關於任何變更功能的文章。直接更新草稿。對於已上線的文章,請將每一篇的確切變更內容發送以供審核。不要發布任何內容。"

以下是它使用 Clevera 工具執行的動作:

1. 讀取發布內容。 git log v2.3..v2.4 以及透過 gh 讀取已合併的 pull requests。這部分是標準的 Claude Code 功能。2. 尋找網站。 list_sites 會回傳網站 ID 以及自動發布功能是否開啟。3. 檢查更新日誌。 list_changelog 會顯示最近的條目,確保不會重複公告相同的變更。4. 草擬條目。 create_changelog_entry 將其儲存為草稿,包含標題、類別以及連結至相關文章的 Markdown 內文。5. 尋找受影響的文章。 search_content 和 get_site_tree 會找出提及變更功能的頁面。get_page 會讀取每一篇文章。6. 撰寫編輯內容。 對於尚未上線的文章,update_article 會寫入新文字。它需要讀取修訂版本 ID,因此不會覆蓋團隊成員在此期間所做的編輯。對於沒有對應文章的新功能,create_article 會在正確的章節中建立草稿。7. 要求審核。 對於已上線的文章,若無發布權限則無法直接編輯。因此,代理會呼叫 submit_for_review 並附上說明,指出應變更的內容與原因。網站管理員會在收件匣收到通知與連結。

草稿條目的範例(僅供說明,非實際執行結果):

> 更快的發票搜尋與全新的 Slack 應用程式 · 改進、新增 > 搜尋功能現在可在您輸入時依據客戶、金額或編號尋找發票。連接新的 Slack 應用程式以將已付款發票發布至頻道。修正:PDF 匯出功能現在會在每一頁保留您的標誌。以下為兩篇更新文章的連結。

每一項變更都會顯示在頁面歷史紀錄中,並標註代理名稱與所使用的權杖。

第 4 步:審核與發布

Clevera 文件網站的更新日誌條目,包含版本、發布日期以及「詳細資訊」面板中的「新增」、「改進」與「修正」類別(範例資料)

在 Clevera 中開啟文件網站。更新日誌條目位於 Drafts 下。修正措辭、設定 Version,然後點擊 Publish entry。從審核通知中開啟文章,套用或調整變更,然後發布網站。條目會在發布時同步上線。

這裡有兩個重要的設定:

  • 自動發布 (Auto-publish)。 開啟後,已上線頁面的變更會在停止編輯幾分鐘後自動發布。如果您希望每次發布都經過審慎確認,請將其關閉。
  • 語言 (Languages)。 在多語言網站上,發布條目會將其翻譯成每種語言。這會消耗點數。

如果您信任代理進行線上編輯,Publisher 權杖可以編輯已上線的文章並進行發布。只有擁有者、管理員和編輯者可以授予發布權限。工具仍會指示代理僅在您明確要求時才發布。大多數團隊應從 Writer 開始,並在幾次發布後再做決定。

選用:為變更後的流程製作新的教學影片

變更後的畫面通常意味著舊影片也已過時,且有一套完整的 在 UI 變更後更新教學影片 的流程。Claude Code 可以利用您 Clevera 媒體庫中已有的錄影來製作新的教學影片。它無法錄製您的螢幕,因此請先錄製新的操作流程。

這需要一個可能會消耗點數的權杖,例如 Producer 預設設定,它也包含了 Writer 的所有功能。請先詢問報價。一段 5 分鐘以內的教學影片通常花費 5 到 25 點。將 Approve automatically below 保持預設值 0,擁有者或管理員會在 Agent requests 中核准每一項付費請求。影片隨後可以作為影片區塊放入文章中。

何時不需要此功能

如果您的說明文件是以 Markdown 形式存放在與程式碼相同的儲存庫中,Claude Code 可以直接編輯這些檔案,您可以像處理其他變更一樣審核合併請求。您不需要為此使用 MCP 伺服器。此工作流程適用於說明中心與更新日誌存放在託管工具中,且支援與產品人員也會共同編輯的團隊。正在比較託管方案?請參閱我們的 文件 MCP 伺服器 彙整與 最佳 AI 更新日誌產生器。

常見問題

Claude Code 可以不經我同意發布更新日誌嗎? 使用 Writer 權杖無法。它只能草擬。Publisher 權杖可以發布,但 Clevera 的工具會指示代理僅在您要求時才發布。

如果團隊成員同時編輯文章會發生什麼事? 代理的更新會因修訂衝突而失敗,工具會指示它重新讀取文章並將變更套用至新版本。您團隊成員的編輯內容不會被覆蓋。

這會消耗點數嗎? 閱讀、草擬、更新與審核請求皆不消耗點數。翻譯條目或文章以及製作影片才會消耗。

使用 Claude Code 更新文件需要什麼方案? AI 代理與 API 功能需 Pro 或更高方案。文件網站及其變更日誌則適用於所有方案。

它能與其他代理搭配使用嗎? 可以。Codex、Cursor 與腳本皆透過相同類型的權杖連接,而 Claude 與 ChatGPT 則透過登入連接。查看所有 Clevera 整合功能。

將其納入發布流程

將您的提示詞儲存在儲存庫中,放在發布腳本旁,並在每次標記版本時執行。首次執行需要幾分鐘進行設定。之後,變更日誌草稿與過時文章列表就會準備就緒,無需他人催促。 查看代理程式還能透過 Clevera MCP 伺服器做什麼 →