OpenWiki は、コードベースのドキュメントを生成・保守するためのオープンソースCLIツールです。リポジトリのWikiを作成し、それをコーディングエージェントに接続し、コードの変更に応じてドキュメントを最新の状態に保ちます。OpenWiki 0.2 では、Google Cloud が提案する知識Wiki構造化標準であるOKFをサポートし、開発者がコードベースのWikiをより適切に分類・整理できるようになりました。
大規模なコードベースでは、当然ながら大規模なWikiが必要になります。Wikiに数百ものファイルがある場合、構造は発見、更新、検索、レビューにとって重要です。OpenWiki 0.2 はOKFのサポートを追加し、生成されるWikiに優れた構造をもたらし、コーディングエージェントがナビゲートしやすくなります。ドキュメントが改善されると、エージェントは検索に多くの時間を費やす必要がなくなり、時間とトークンの消費が削減されます。
OpenWiki 0.2 では、OpenWiki によって生成または更新されたWikiはOKF形式に従います。各Wikiファイルには、タイトル、説明、タグ、カテゴリ、リソースURLなどのフィールドを含むYAMLフロントマターが含まれます。OKFは2つの規約を定義しています：index.md（各Wikiディレクトリ内のファイルとサブディレクトリを要約）とlogs.md（Wikiの更新を変更履歴として追跡）です。変更履歴は特に更新時に有用で、毎回フルWikiを読む代わりに、logs.mdをチェックすることで何が変更され、どのファイルが影響を受け、詳細を確認すべき場所がわかります。
OKF仕様は非常にシンプルで、OpenWikiへの統合が容易です。YAMLフロントマターには、必須のtype、title、description、resource、オプションのtags、timestampなど、いくつかの主要フィールドのみが含まれます。このYAMLフロントマターにより、各ファイルのdescriptionフィールドを抽出してindex.mdファイルを決定論的に生成できます。また、OpenWikiは実行終了時にlogs.mdを自動生成し、変更を記録します。
構造化メタデータにより、エージェントはタグ、カテゴリ、説明などのフィールドに基づいて決定論的検索を行えます。例えば、BigQueryテーブルカテゴリ内の全ドキュメントや、billingタグが付いた全ドキュメントをフィルタリングでき、完全にオープンエンドなエージェント検索に依存する必要がありません。エージェント検索は有用ですが、単純な検索には不必要に遅く高価な場合があります。構造化メタデータは、より高速な検索ツールへの道を提供します。
OKFはオープン形式であるため、OpenWikiのWikiはコミュニティ製のビューア、レンダラー、リンターなどの互換ツールと連携できます。GoogleはオープンソースのOKF Wikiビジュアライザーを公開しており、Wikiを検査し、ドキュメント間の関係を表示できます。
既存ユーザーはアップグレードするだけで、生成されるWikiがOKF形式になります。新規ユーザーはnpmでインストールし、数分でリポジトリWikiを生成できます。