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。