跳至內容
Clevera Help Center

將文章發佈至 Help Scout Docs

使用 Docs API 金鑰連接 Help Scout,並將 Clevera 文章直接發佈到你的文件網站:包含選擇網站與集合、格式、圖片與影片的呈現方式、更新以及常見錯誤訊息。

更新於 閱讀時間 4 分鐘

連接一次 Help Scout,你就能將任何 Clevera 文章連同其中的螢幕截圖與格式發佈到你的 Help Scout Docs 網站。本文涵蓋如何取得 Docs API 金鑰、選擇文章發佈位置、文章在 Help Scout 中的外觀以及更新運作方式。

開始之前

  • 方案: 發佈至 Help Scout 是 Pro 與 Custom 方案的功能。在 Free 與 Starter 方案中,發佈分頁會顯示「發佈至你的工具包含在 Pro 方案中」。請參閱 選擇方案。
  • 在 Clevera 中的角色: 只有工作區擁有者或管理員可以連接或中斷連線 Help Scout。一旦連接完成,任何可以編輯文章的人都能進行發佈。
  • 在 Help Scout 中: 需要一個至少包含一個集合的 Docs 網站,以及一位可以編輯該網站的 Help Scout 使用者。Clevera 是透過該使用者的 Docs API 金鑰來運作的。
  • 文章: 你可以發佈屬於某個影片或錄製內容的文章。請先產生文章;請參閱 將錄製內容轉為文章。

發佈不會消耗點數。

取得你的 Docs API 金鑰

在 Help Scout 中,點擊你的頭像並開啟 Your Profile → Authentication → API Keys。如果沒有金鑰,請產生一個並複製它。連接視窗中也提供了相同的路徑:「在 Help Scout 中,開啟 Your Profile → Authentication → API Keys,複製你的 Docs API 金鑰並貼上至此。」

連接 Help Scout

  1. 開啟整合

    在側邊欄中,開啟工作區選單並選擇 整合。找到 Help Scout(位於 客戶支援 或 知識庫 下方)並點擊 連接。

  2. 貼上並檢查金鑰

    Connect Help Scout 視窗會顯示「貼上金鑰。我們會在儲存前進行檢查。」將金鑰貼上至 文件 API 金鑰 並點擊 檢查金鑰。當 Help Scout 接受金鑰後,你會看到「金鑰已接受」。

    顯示已接受 Docs API 金鑰以及 Your Profile、Security 與 Access 提示的 Connect Help Scout 視窗
    Clevera 會在儲存前檢查金鑰。
  3. 選擇網站

    在 發佈目標網站 下方,會預設選取你所有的文件網站。取消勾選任何你不希望發佈到的網站;至少必須保留一個網站被選取。

    選擇要發佈到的 Help Scout 文件網站,兩個網站皆已勾選
  4. 連接

    點擊 連接。你會看到「Help Scout 已連接。」,且 Help Scout 會移至 已連接 清單中,名稱會以你選擇的第一個網站命名(若有其他網站則會顯示「+1 more」等)。

若要稍後變更網站,請開啟 整合,點擊 Help Scout 列上的 ⋯ 選單,選擇 重新連線,再次貼上金鑰並選擇網站。重新連線會取代舊的連接;一個工作區僅能持有一個 Help Scout 連接。

發佈文章

  1. 開啟發佈分頁

    在編輯器中,點擊 分享 並開啟 發佈 分頁。在 發佈文章 下方,點擊 準備發布 區塊中的 Help Scout 圖示。

    文章會以你在編輯器中開啟的語言進行發佈。若要發佈翻譯版本,請先在頂部列切換語言。

  2. 選擇網站與集合

    在 發佈位置 下方,進行選擇:

    欄位 顯示內容 備註
    文件網站 你在連接時選擇的網站 若只有一個網站,會顯示其名稱與網址;若有多個,請選擇一個。系統會預設選取第一個
    集合 該網站的 Help Scout 集合 載入時會顯示「正在載入集合…」。文章會發佈至你選擇的集合中
    發佈至 Help Scout 表單,選擇了 Acme Help Center 文件網站與 Getting started 集合

    Clevera 不會將文章放置在集合內的特定類別中。若要將其加入類別,請在發佈後於 Help Scout 中操作。

  3. 發佈

    點擊 發佈至 Help Scout。你會看到「正在 Help Scout 中尋找現有副本」,接著是 正在寫入頁面。完成後會顯示「已發佈至 Help Scout。」點擊 在 Help Scout 中開啟 即可查看文章。

    發佈過程中你可以關閉分享視窗;完成時會收到通知。

文章在 Help Scout 中的外觀

  • 標題: 文章以所選語言呈現的標題。
  • 螢幕截圖: 上傳至 Help Scout 並儲存於該處,因此即使沒有 Clevera 也能正常運作。如果上傳失敗,圖片會連結至不會過期的 Clevera 副本。透過網址新增至文章的圖片將維持連結至該網址。
  • 影片: 文章來源的影片不會被加入。你放入文章內的影片會保留在原位(請參閱表格)。
  • 格式: 標題、粗體、斜體、底線、刪除線、連結、清單、表格與程式碼區塊會以標準 Help Scout 格式呈現。指向其他 Clevera 頁面的連結僅會保留其文字。
在 Clevera 文章中 在 Help Scout 中
標註 (Callouts) 帶有圖示的彩色方塊,標註標題為粗體(藍色資訊、黃色警告、綠色提示與成功、灰色備註、紅色危險)
編號步驟 帶有步驟標題作為標題的編號清單
分頁 (Tabs) 每個分頁皆有標題,內容位於下方;所有分頁皆會顯示
切換開關 (Toggles) 可摺疊的區塊
核取清單 以 ☐ 或 ☑ 開頭的行
醒目提示、上標、下標 保留
方程式 程式碼
卡片 帶有描述的連結清單;卡片圖示會被省略
YouTube 影片與 Clevera 影片 嵌入式播放器。Clevera 影片僅在該影片的分享連結開啟時才會包含在內。
影片檔案 帶有影片標題的連結

更新已發佈的文章

發佈僅為單向。你在 Clevera 所做的編輯會保留在 Clevera 中,直到你再次發佈;而在 Help Scout 中對文章所做的變更不會同步回 Clevera。

當你選擇的集合中已存在標題相同的文章(不區分大小寫)時,Clevera 會顯示「此文章已存在於 Help Scout 中」。點擊 查看 將其開啟,然後選擇:

選項 Help Scout 中的結果 按鈕
更新現有文章 現有文章的標題與文字將被取代。其網址保持不變。 在 Help Scout 中更新
建立新文章 「保留現有文章,並以新標題新增此文章。」Clevera 會建議一個 新標題,例如「建立你的第一張發票 (2)」。 建立新文章

Help Scout 不允許在同一個集合中有兩篇標題相同的文章。如果在發佈過程中出現另一篇相同標題的文章,Clevera 會再次檢查並顯示相同的選項,而不會失敗。

發佈至不同的集合會在那裡建立一篇新文章;你之前發佈的文章會留在原處。若要移動已發佈的文章,請在 Help Scout 中進行移動。

Clevera 中的任何操作都不會刪除 Help Scout 中的文章。

中斷連線 Help Scout

  1. 開啟 整合,點擊 Help Scout 列上的 ⋯ 選單並選擇 中斷連線(或點擊 Help Scout 然後點擊 中斷連線)。
  2. 確認。系統會提示「你將無法再從編輯器發佈至此。你已發佈的內容將保留在 Help Scout 中。」

中斷連線會從 Clevera 刪除金鑰。該金鑰本身在 Help Scout 中仍然有效,直到你在 Help Scout 的 Your Profile → Authentication → API Keys 中刪除或重新產生它為止。

疑難排解

你會看到 該怎麼做
「整合功能包含在 Pro 和 Custom 方案中。」 將工作區升級至 Pro。請參閱 選擇方案。
整合頁面上沒有 連接 按鈕 只有擁有者或管理員可以進行連接。請詢問他們。
「你可以查看此項目,但無法發布。請詢問有編輯權限的人。」 你需要該文章的編輯權限才能發布。
「請先貼上金鑰。」 在點擊 檢查金鑰 之前,請先貼上 Docs API 金鑰。
「API 金鑰無效。請檢查你的 Help Scout Docs API 金鑰。」 金鑰錯誤或已重新產生。請從 Help Scout 再次複製。請使用 Docs API 金鑰,而非 Mailbox 應用程式 ID 或密鑰。
「找不到 Docs 網站。請先在 Help Scout Docs 中建立網站。」 該金鑰的使用者沒有 Docs 網站。請在 Help Scout 中建立一個,或使用可存取該網站的使用者金鑰。
「無法從 Help Scout 取得網站。」或「我們無法檢查該金鑰。再試一次。」 Help Scout 沒有回應。請稍後再試一次。
「請至少選擇一個網站。」 在 發佈目標網站 下選擇至少一個網站。
「無法連接到 Help Scout。請檢查你的 API 金鑰。」或「無法連接。再試一次。」 請檢查金鑰並再試一次。
「驗證嘗試次數過多。請稍後再試。」 你每分鐘最多可檢查 10 次金鑰。請稍候一分鐘。
「請先在整合頁面上連接 Help Scout。」 此工作區尚未連接 Help Scout。請詢問擁有者或管理員進行連接。
「尚未有 Docs 網站。請先在 Help Scout 中建立一個。」 請在 Help Scout 中建立 Docs 網站,然後 重新連線,以便 Clevera 能偵測到它。
「此網站中沒有選集」/「請在此 Docs 網站中建立一個選集以發布至此。」 該網站沒有選集。請在 Help Scout 中建立選集,然後再次開啟 發布。
「請先選擇網站和選集。」或「請選擇要發布到的選集。」 發布前請同時選擇網站和選集。
「無法載入你的 Help Scout 位置」 點擊 再試一次。如果問題持續發生,請重新連線 Help Scout。
「文章已建立,但無法擷取文章 ID。請檢查 Help Scout。」 文章可能已建立。在再次發布前,請先檢查 Help Scout 中的選集,以免產生重複內容。
「無法發布至 Help Scout。請再試一次。」或「無法更新 Help Scout 中的文章。請再試一次。」 點擊 再試一次。如果持續失敗,請重新連線 Help Scout 並聯絡支援團隊。
「找不到 API 金鑰。請重新連線 Help Scout。」 Clevera 已遺失金鑰。請從 整合 重新連線 Help Scout。
「文章內容為空或無效。」 該語言的文章沒有內容。請生成或撰寫內容後,再次發布。
「找不到文章。請先生成文章。」 該影片在目前開啟的語言中沒有對應文章。請生成文章或切換語言。
「發布嘗試次數過多。請稍候片刻再試。」 你每分鐘最多可發布 20 次。請稍候一分鐘。
連線顯示 錯誤 或 需要注意 Help Scout 不再接受該金鑰。點擊 重新連線 並貼上目前的金鑰。