跳至內容
Clevera 與 Bitbucket

Bitbucket 整合

將螢幕錄影指南以 Markdown 格式發佈至 Bitbucket

專為使用 Atlassian 工具鏈的團隊設計。只需錄製一次工作流程,Clevera 就會自動撰寫指南,並將其連同截圖以 Markdown 檔案形式 commit 到您的 Bitbucket Cloud 儲存庫中,隨時可用於 README、docs 資料夾或您的文件網站。

Bitbucket Cloud

Bitbucket 可顯示的 Markdown

儲存庫中的截圖

可與 Confluence 搭配使用

您可以做什麼

為 Atlassian 團隊編寫開發者文件,
根據您螢幕上的操作自動生成。

工程團隊使用 Jira 和 Bitbucket,公司其他部門則閱讀 Confluence,而操作指南往往因此被遺漏。Clevera 填補了這個缺口:同一份錄影既能成為儲存庫中的 Markdown 指南,也能視需要成為 Confluence 空間中的頁面。

將演示轉為指南

錄製設定步驟、發佈檢查清單或新功能。Clevera 會自動撰寫包含編號步驟與截圖的指南,讓您無需在衝刺 (sprint) 後手動輸入。

Bitbucket 可顯示的 Markdown

由於 Bitbucket 的檔案檢視器不支援渲染原始 HTML,Clevera 會撰寫不含 HTML 的純 Markdown。指南不僅在文件網站上,在儲存庫中也能清晰易讀。

截圖位於同一個 commit 中

圖片會與 Markdown 檔案一同 commit,並透過相對路徑連結。即使沒有 Clevera,它們也能正常運作,並保有與儲存庫相同的隱私層級。

適用於 Bitbucket Pipelines

每次發佈都是主分支上的一次普通 commit。如果 Pipelines 從儲存庫建置您的文件網站,它會像處理其他變更一樣處理新指南。

一次錄影,兩個 Atlassian 歸宿

透過同一個「分享」視窗,將文章同時發佈至開發者使用的 Bitbucket 儲存庫,以及所有人都能存取的 Confluence 空間。

重新發佈,無需重複

當 UI 變更時,只需更新文章並再次發佈。Clevera 會找到現有檔案並在新的 commit 中覆寫它。

運作方式

從錄影到儲存庫
只需四個步驟。

擁有者或管理員只需連接一次 Bitbucket。之後,任何能編輯文章的人都可以直接從編輯器進行發佈。

  1. 1

    連接 Bitbucket Cloud

    登入 bitbucket.org 並授權 Clevera 讀取您的帳戶,以及讀寫您的儲存庫。
  2. 2

    Clevera 撰寫指南

    根據螢幕錄影,Clevera 會自動撰寫文章:包含標題、編號步驟、提示框與截圖。
  3. 3

    選擇儲存庫與資料夾

    在「分享」中開啟「發佈」,選擇儲存庫與資料夾(例如 docs),然後點擊「發佈至 Bitbucket」。
  4. 4

    自動存入主分支

    Markdown 檔案及其圖片會以一個 commit 的形式存入儲存庫的主分支。

在 Clevera 中查看

發佈至 Bitbucket,
從文章的「分享」視窗進行。

每篇文章都有一個「分享」視窗,包含連結、嵌入程式碼、下載選項與「發佈」分頁。Bitbucket 是該分頁中的一個選項。

選擇儲存庫與資料夾

清單中列出了已連接帳戶有權貢獻的所有 Bitbucket 工作區儲存庫,按最近更新排序。輸入資料夾名稱(例如 docs);若該資料夾不存在,Clevera 會自動建立。

系統會記住您的選擇,因此發佈下一份指南只需點擊兩次。

Clevera 的「發佈至 Bitbucket」表單,已選取 product-docs 儲存庫與 docs 資料夾
發佈至 Bitbucket:product-docs 儲存庫與 docs 資料夾。

更新現有檔案

Clevera 在寫入前會檢查資料夾中是否有同名檔案。更新它,同一個檔案及其圖片將在名為「Update article: …」的 commit 中被覆寫。或者,您可以保留舊檔,並將此版本作為新檔案以新標題新增。

在 Bitbucket 中所做的編輯不會同步回 Clevera,因此發佈過程永遠是單向的。

當文章已存在於 Bitbucket 時,Clevera 的提示:更新現有檔案或建立新文章
文章已存在於 Bitbucket:在新的 commit 中更新它,或以新標題新增。

Bitbucket 與 Confluence 並行

連接 Confluence 後,同一篇文章也能以 Confluence 頁面形式發佈至空間,並附上截圖。開發者在程式碼旁閱讀,支援與銷售團隊則在 Wiki 中閱讀。

Clevera 文章的「發佈」分頁,顯示 Bitbucket 與 Confluence 已準備好發佈,並反白顯示 Bitbucket
同時準備好發佈至 Bitbucket 與 Confluence 的「發佈」分頁。

自動填寫

存入儲存庫的內容
以及在 Bitbucket 中的顯示方式。

Bitbucket 顯示 Markdown 的方式與 GitHub 和 GitLab 略有不同。Clevera 專為 Bitbucket 進行了優化,確保不會產生多餘的標籤。

儲存庫與資料夾由您選擇
任何已連接帳戶有權貢獻且對主分支擁有寫入權限的儲存庫。資料夾預設為 docs;若留空則存於儲存庫根目錄。
檔案名稱自動設定
標題會轉為小寫並以連字號連接,結尾為 .md:「Deploy to staging」會變成 deploy-to-staging.md。非拉丁語系的標題會先轉寫為拉丁字母。
提示框自動轉換
以表情符號開頭並加粗標題的引用區塊:ℹ️ 資訊, 💡 提示, ⚠️ 警告, 📝 註記, ✅ 成功, 🚨 危險。在 Bitbucket 檢視器中的顯示效果與文件網站相同。
折疊區塊與數學公式自動轉換
由於不支援原始 HTML,折疊區塊會變為加粗的摘要,內容直接顯示在下方。方程式會變為 math 程式碼區塊,因為 Bitbucket 不支援渲染數學公式。
截圖自動設定
Commit 至 assets/<file name>/ 與檔案位於同一個 commit 中,標題以斜體顯示。
Front matter 與 Commit自動設定
一小段 YAML 區塊,內含 title, created_at, updated_at 與 source的簡短 YAML 區塊。Commit 訊息為「Add article: …」或「Update article: …」,由連接 Clevera 的帳戶執行。

設定

設定 Bitbucket 整合
只需約兩分鐘。

您需要一個 Pro 或 Custom 方案的 Clevera 工作區以及一個 Bitbucket Cloud 帳戶。由工作區擁有者或管理員進行連接;之後,任何能編輯文章的人皆可發佈。發佈過程不消耗額度。

  1. 1

    開啟整合功能

    在 Clevera 中,開啟工作區選單,選擇 Integrations,在「」下方找到 Bitbucket Code repositories 下方找到 Bitbucket 並點擊 Connect.
  2. 2

    在 Bitbucket 中授權

    Bitbucket 會要求您允許 Clevera 讀取您的帳戶並讀寫儲存庫。點擊 Grant access.
  3. 3

    檢查分支規則

    如果主要分支設有限制,請在「」下方將已連結的帳戶加入可寫入該分支的人員名單 Repository settings → Branch restrictions.
  4. 4

    中,將已連接的帳戶加入擁有寫入權限的人員清單。

    發佈文章 在編輯器中點擊Share ,開啟,點選 Bitbucket 磚塊,選擇儲存庫和資料夾,再點選 ,點擊 Bitbucket 選項,選擇儲存庫與資料夾,然後點擊.
  5. 5

    Publish to Bitbucket

    在 Bitbucket 中開啟 當您看到「Published to Bitbucket.」時,點擊 Open in Bitbucket

即可查看檔案。

不行。Clevera 僅連接 Bitbucket Cloud (bitbucket.org),不支援 Bitbucket Data Center 和 Server。

Clevera 會建立 Pull Request 嗎? 否。它會直接 commit 到儲存庫的主分支(通常是 main 或,而且無法選擇其他分支。如果分支限制規定只能透過提取要求進行變更,Bitbucket 就會拒絕提交。

為什麼我看到「You need write access to commit to this Bitbucket repository」? Repository settings → Branch restrictions已連接的帳戶無法寫入主分支,通常是因為分支限制。請在

Clevera 會將指南連結至 Jira 問題嗎? Confluence.

提示會以引言形式呈現,包含表情符號和粗體標題,Bitbucket 能很好地顯示這些內容。檢查清單會轉換為 Markdown 任務清單;Bitbucket 可能會將方框顯示為文字。醒目標示和上標則會轉成純文字。

在你再次發布之前,Bitbucket 不會有任何變更。之後,你可以透過新的提交覆寫現有檔案。重新命名的文章會成為新檔案;請自行在 Bitbucket 刪除舊檔案,因為 Clevera 絕不會刪除檔案。

發佈至 Bitbucket 包含在 Pro 與 Custom 方案中,且不消耗點數。製作文章則照常消耗點數。請參閱 定價.

演示一次。在 Bitbucket 中輕鬆存取。

Clevera 會根據您的錄製內容撰寫指南,並將其連同螢幕截圖一併提交至儲存庫。