Code Wiki icon

Code Wiki

認証する

Code Wiki は、コードリポジトリ向けのAIドキュメントハブ。要約、アーキテクチャ図、repo Q&Aでコードベースの理解と把握を素早く支援し、オンボーディングや探索に役立ちます。

Code Wiki

概要

Code Wiki は、コードリポジトリ向けの AI ドキュメントハブです。ソースコードを解析し、自然言語の要約、アーキテクチャ図、その他のリポジトリ情報を生成して、開発者がコードベースをより سریعく理解できるように支援します。

この製品には、生成された Wiki コンテンツを主なコンテキストとして使う会話形式の「この repo について質問する」体験も含まれています。そのため、初期オンボーディングだけでなく、構造、動作、リポジトリの詳細に関する追加質問にも役立ちます。

機能

リポジトリ документацииの自動生成

専用の AI エージェントがリポジトリのソースコードを解析し、自然言語の要約を生成するため、手動でドキュメントを作成・維持しなくても内容を把握できます。

生成されたアーキテクチャ図

Wiki には、コードベース内の関係、階層、依存関係を示すアーキテクチャ図が含まれており、ズームやパンに対応したインタラクティブ表示で確認できます。

Repo Q&A チャット

会話形式の体験により、ユーザーは Wiki コンテンツを主なコンテキストソースとしてリポジトリに関する質問をできます。

リポジトリの検索とアクセス

検索でホームページから名前を指定してリポジトリを探せるほか、リポジトリページからその Wiki へ直接つながる URL 形式も用意されています。

継続的なコンテンツ更新

Wiki は静的なままではなく定期的に更新されるため、ソースリポジトリの変更に合わせて生成ドキュメントも時間とともに更新されます。

Wiki ページの自動管理

公開 Wiki ページは読み取り専用で、直接編集や pull request を受け付けないため、生成されたドキュメントをソースリポジトリに整合させやすくなっています。

ユースケース

  • 新しいコードベースへのオンボーディング

    新しいリポジトリに参加した開発者は、ソースを詳しく開く前に、生成された要約と図を使ってコードベースの構造を理解できます。

  • リポジトリ Q&A

    チームは、ファイルを手作業で探す代わりに、リポジトリに関する素早い回答が必要なときの参照先として Wiki を利用できます。

  • コードベースの探索

    公開オープンソースプロジェクトを評価している人は、Wiki を閲覧して、コード全体を読む前にアーキテクチャと主要コンポーネントの高レベルな把握ができます。

  • ドキュメントを最新に保つ

    リポジトリの所有者は、別途手動のドキュメント運用を行わなくても、定期更新されるドキュメントによりソース変更に合わせて生成コンテンツを維持できます。

Pros and Cons

Pros

  • リポジトリのソースコードからドキュメントを自動生成します。
  • テキスト要約に加えて図でアーキテクチャを可視化します。
  • 対象を絞った質問のためのリポジトリ固有のチャットワークフローをサポートします。
  • サイト上の公開オープンソースリポジトリは無料で利用できます。
  • 直接編集や pull request を受け付けないため、ドキュメントがソースに整合しやすくなっています。

Cons

  • 現在は GitHub リポジトリのみをサポートしています。
  • Wiki は継続的ではなく定期的に更新されるため、鮮度はプロジェクトごとに異なる場合があります。
  • FAQ ではチャットアシスタントが誤りを含む可能性があるとされているため、コードと回答は引き続き確認・検証する必要があります。

FAQ

Code Wiki とは何ですか?

Code Wiki は、コードリポジトリ向けの AI ドキュメントハブです。ソースコードを解析して、要約、アーキテクチャ図、その他のリポジトリに関する洞察を生成し、リポジトリについて質問できるチャット体験も提供します。

Code Wiki は Gemini とどのような関係がありますか?

Code Wiki は Google の Gemini モデル上に構築されています。FAQ では、特化した AI エージェントが Gemini を使ってソースコードを解析し、Wiki コンテンツを生成すると説明されており、チャット体験も Gemini によって提供され、Wiki をコンテキストとして利用します。

Code Wiki は無料で使えますか?

codewiki.google 上のオープンソースリポジトリ向けの公開 Code Wiki は無料で利用できます。

どのコードホスティングプラットフォームがサポートされていますか?

Code Wiki は現在、GitHub でホストされているリポジトリのみをサポートしています。FAQ では、GitLab や Bitbucket など他のプラットフォームへの対応は将来的に予定されていると説明されています。

ドキュメントはどの程度最新ですか?

Wiki は定期的に更新され、更新タイミングは人気度、利用状況、その他の要因に基づいてプロジェクトごとに異なります。FAQ では、最終生成日時がページ左下に表示されることも記載されています。

Quick Facts

カテゴリ
開発者向けツール
主な用途
コードベース文書の自動生成と repo Q&A
対応プラットフォーム
GitHub リポジトリのみ
価格
公開オープンソースリポジトリは無料
ソースドメイン
codewiki.google
注目のワークフロー
リポジトリを検索し、その Wiki を開いて repo について質問する