Skip to main content
ナレッジ

Repo Wiki

Repo Wiki は、プロジェクトの構造化ドキュメントを自動生成し、コードとドキュメントの変更を継続的に追跡します。 開発中に知識ポイントやコードの説明を照会したり、機能を追加したりする際、Repo Wiki はプロジェクト構造とコード実装を深く分析します。Repo Wiki とコンテキスト情報を組み合わせることで、より正確で詳細な回答とドキュメントサポートを提供し、エージェントにコードベースへのより深い理解をもたらします。
Repo Wiki

適用シナリオ

  • アーキテクチャと実装に関するクエリ
    エージェントは構築済みのアーキテクチャ知識を利用して、ツールをほとんど呼び出すことなく、「X はどのように実装されていますか？」や「どのサービスがこのモジュールに依存していますか？」といった質問にすばやく回答できます。
  • エージェント主導の開発タスク
    コンテキストの幅が制限されている場合、Repo Wiki はコードの特定を加速し、以下のタスクをサポートします：
    • 新機能の追加
    • バグの修正

Repo Wiki の生成

リポジトリ内の Wiki は静的なものではありません。コードと同期を保ちます。 Wiki は 3 つの重要な状況で更新されます。トリガーのタイミングと理由を理解することで、Wiki をリアルタイムで更新し続けることができます。
  1. 初回の Wiki 生成 プロジェクトを初めて開いたとき、デフォルトでは Wiki は存在しません。ワンクリックでゼロから生成できます。
  2. コード変更の検出 初回生成後、システムはコードの変更を継続的に監視します。 Wiki に記録されている内容（関数シグネチャ、クラス定義、API エンドポイントなど）を変更した場合、システムは現在のコードと既存の Wiki との不一致を検出します。更新 をクリックすると、影響を受ける部分のみを再生成できます。
  3. Git ディレクトリの同期 Git ディレクトリ内の Markdown ファイルを直接編集した場合、システムは Git コンテンツと Wiki の不一致を検出します。同期 をクリックすると、Git の変更を同期して Wiki を更新できます。
  4. 生成の制限
    • プロジェクトごとに最大 10,000 ファイル。プロジェクトに 10,000 以上のファイルが含まれる場合は、Qoder IDE Settings → Codebase Indexing → Index Exclusions で不要なパスを除外することをお勧めします。
    • 少なくとも 1 つのコミットを持つ Git リポジトリのみがサポートされます。

Wiki 生成への介入

Repo Wiki は「一度生成したら読み取り専用」という成果物ではありません。生成前に設定ファイルで方向性を導くことも、生成後にいつでも変更することもできます。チームによる知識の修正はすべてシステムに新たな認知の蓄積として認識され、次の自動更新で上書きされることなく、対応するナレッジカードに逆方向で同期されます——人の判断を真にナレッジ資産に書き込みます。

/knowledge コマンド

チャット入力欄で と入力すると、Repo Wiki とナレッジカードへの介入が可能です：
操作説明
生成プロジェクトの Wiki またはナレッジカードを初めて生成
修正既存の知識コンテンツを部分的に変更
追加既存の知識に新しいコンテンツを追記
書き換え知識ページまたはカードを完全に書き換え
使い方：
  1. 入力欄で を呼び出す
  2. 必要な変更内容を記述する指示を入力
  3. 参考としてローカルファイルをアップロード可能（設計ドキュメント、API ドキュメントなど）
  4. Agent が指示に基づいて対応する知識コンテンツを変更
手動で変更されたコンテンツはシステムによってマークおよび保護され、次の自動更新時に上書きされません。チームの知識修正のすべてが永続的なナレッジ資産となります。

wiki_plan.yaml — 事前介入設定

設定ファイルを通じて、Wiki 生成前にガイド意図を注入し、生成の方向性と範囲を制御できます。 チャット入力欄で /knowledge-plan コマンドを入力すると、wiki_plan.yaml 事前介入設定ファイルを作成または編集でき、Wiki とナレッジカードの生成戦略を制御します。
/knowledge-plan コマンド
 ファイルの場所： 
<プロジェクトルート>/.qoder/repowiki/wiki_plan.yaml
このファイルは Git コミットを通じてチームと共有されます。 設定構造： 
version: 1

repowiki:
  template: ""           # プリセットテンプレート（architecture / product_requirement）
  notes:                 # 計画フェーズに注入するガイダンスプロンプト
    - text: "プロンプト本文"
      author: "署名"
  documents:             # ページホワイトリスト（指定時はリストどおりに厳密に出力）
    - title: "ページタイトル"
      goal: "このページの執筆意図"
      parent: ""         # 任意。親ページのタイトル
      hints: ""          # 任意。追加の執筆ヒント

knowledgecard:
  notes:                 # ナレッジカードの計画フェーズに注入するガイダンスプロンプト
    - text: "プロンプト本文"

scope:
  include: []            # ファイルホワイトリスト（.gitignore 構文）
  exclude: []            # ファイルブラックリスト（.gitignore 構文）
主な設定項目：
設定項目説明
repowiki.templateプリセットテンプレート：architecture（包括的な技術分析）または product_requirement（製品要件形式で出力）
repowiki.notes計画フェーズに注入するガイダンスプロンプト、AI の注力ポイントを誘導
repowiki.documentsページホワイトリスト、指定時はリスト通りに厳密にページを生成
knowledgecard.notesナレッジカードガイダンスプロンプト、モジュール分割の方向に影響
scope.include / exclude生成時に可視なファイル範囲を制御
例： 
version: 1

repowiki:
  notes:
    - text: "ドキュメントはコードの詳細ではなく業務フローに焦点を当て、新規入社のエンジニア向けにする"
  documents:
    - title: "システムアーキテクチャ概要"
      goal: "システム全体のアーキテクチャ、コアモジュールおよびその相互関係を記述する"
    - title: "注文システム"
      goal: "注文のライフサイクル全体を説明する"
      parent: "システムアーキテクチャ概要"

knowledgecard:
  notes:
    - text: "決済と注文の2つのコアサブシステムを重点的にモデリングする"

scope:
  include:
    - "src/**"
  exclude:
    - "**/test/**"
wiki_plan.yaml を変更した後、「生成」または「再生成」を手動でトリガーする必要があります。

Repo Wiki の共有

チーム内での知識の流動性を高めるために、Wiki の共有をサポートしています。 チーム管理者が Web コンソールでナレッジのトグルを有効にすると、チームメンバーが生成した Repo Wiki は自動的にチームに同期されます。他のメンバーは同じリポジトリの同じブランチを開き、生成をクリックするだけでチームの最新知識を自動的に取得できます——手動での pull は不要です。チームメンバーによるプロジェクト知識への変更はすべて全員に同期更新され、チームの知識が常に一貫して最新の状態に保たれます。
自動チーム共有は Teams プランでのみ利用可能です。それ以外の場合は、Git 同期を使用して知識を管理することもできます。
チーム共有で同期されるのは生成済みの Wiki ドキュメントの内容のみであり、ソースコード自体はアップロードされません。
ローカルで Wiki を生成すると、システムはコードリポジトリに専用ディレクトリ .qoder/repowiki を自動的に作成します。
Wiki の共有
 このディレクトリをコミットし、リモートブランチにプッシュできます。チームメンバーは追加の構成なしで、git pull を介して生成された Wiki コンテンツを取得できます。

多言語サポート

Wiki システムは多言語をサポートしています。Wiki 生成時に希望する言語を選択できます。現在、英語と中国語がサポートされています。 Wiki 生成時、システムは言語選択に基づいて、選択した言語ごとの独立したディレクトリを Git ディレクトリの下に自動的に作成します（例：repowiki/zh/、repowiki/en/）。

課金

生成と更新は通常通り Credits を消費します。消費履歴は使用量 - Creditsで確認できます。

データセキュリティ

Repo Wiki の生成はローカルクライアント上で実行されます。複数の Agent がローカルで起動し、タスクの計画、コードの検索、ドキュメント構成の計画などを行います。Agent はタスクに必要なリポジトリ内のファイルのみを読み取ります。
  • コードベース全体をアップロードしない：生成中にコードベース全体がクラウドへアップロードされることはありません。
  • サーバー側に保持しない：コードはサーバーに保存されず、生成結果はローカルリポジトリにのみ保存されます。
  • デフォルトで無効：Repo Wiki はデフォルトで無効になっており、利用するには有効にする必要があります。自動増分更新も任意で有効または無効にできます。
はじめに
ユーザーガイド
コンテキスト
拡張機能
設定
サポート