OpenWiki 0.2 為程式碼庫文件引入 OKF 支援
OpenWiki 0.2 版本增加了對 OKF(一種知識 wiki 結構化標準)的支援,使開發者能夠更好地組織和分類程式碼庫文件,提升代理檢索效率並減少令牌消耗。
OpenWiki 是 LangChain 開發的開源命令列工具,用於生成和維護程式碼庫文件。它能為倉庫建立 wiki,並將其與編碼代理連線,在程式碼變更時自動更新文件。OpenWiki 0.2 版本引入了對 OKF 的支援,這是一種由 Google Cloud 提出的知識 wiki 結構化標準,旨在幫助開發者更好地分類和整理程式碼庫 wiki。
大型程式碼庫通常需要龐大的 wiki 系統,包含數百個檔案。此時,文件的結構化對於發現、更新、搜尋和審查至關重要。OpenWiki 0.2 透過採用 OKF 格式,為生成的 wiki 新增了更清晰的結構,使編碼代理能夠更輕鬆地導航,從而減少搜尋時間和令牌消耗。
在 OpenWiki 0.2 中,每個 wiki 檔案都包含 YAML 前置後設資料,包括標題、描述、標籤、類別和資源 URL 等欄位。OKF 定義了兩個關鍵約定:index.md 用於彙總每個 wiki 目錄中的檔案和子目錄,而 logs.md 則記錄 wiki 隨時間的變化,類似於變更日誌。變更日誌特別有助於快速瞭解更新內容:開發者無需在每次執行後閱讀整個 wiki,只需檢視 logs.md 即可知道哪些檔案被修改以及需要關注哪些細節。
OKF 規範本身非常簡單,易於整合。其 YAML 前置後設資料僅包含幾個關鍵欄位,例如型別(必需)、標題、描述、資源 URL、可選標籤和時間戳等。透過這些後設資料,可以確定性生成 index.md 檔案:從每個檔案的描述中提取內容,生成類似“標題1 - 描述1”的條目。而 logs.md 則由 OpenWiki 在每次執行結束時自動生成,記錄其修改歷史,例如“2026-05-22:更新 - 新增了新的 BigQuery 表引用”。
結構化後設資料還為代理提供了更好的檢索能力。OpenWiki 透過 AGENTS.md 和 CLAUDE.md 等檔案將 wiki 暴露給編碼代理。由於 OKF 為每個文件新增了結構化後設資料,未來的 OpenWiki 工具可以支援基於標籤、類別、描述等欄位的確定性搜尋,而非完全依賴代理的開放式搜尋。開放式搜尋雖然有用,但對於簡單查詢而言可能過於緩慢且昂貴。結構化後設資料為 OpenWiki 提供了更高效檢索工具的路徑。
由於 OKF 是一種開放格式,OpenWiki 生成的 wiki 可以與社群構建的檢視器、渲染器、程式碼檢查器等相容工具配合使用,無需依賴單一整合。Google 還發布了開源的 OKF wiki 視覺化器,可用於檢查 wiki 並檢視文件之間的關係。
對於現有使用者,升級到 OpenWiki 0.2 後,生成的 wiki 將自動採用 OKF 格式。新使用者可透過 npm 全域性安裝並初始化,只需幾分鐘即可生成倉庫 wiki。