Skip to main content

ナレッジカード

プロジェクトのアーキテクチャ、コーディング規約、技術スタックを抽出し、Qoder のタスクで参照できるようにします。

ナレッジカードは、コードベースから抽出されたコンパクトな知識単位です。Repo Wiki とともに、Qoder にプロジェクトコンテキストを提供します。アーキテクチャ、コーディング規約、技術スタックの情報を記録し、Agent によるプロジェクトの理解、コードの作成、問題の調査を支援します。

ナレッジカードの種類

  • アーキテクチャ文書:モジュール構造、サービスの依存関係、設計上の決定事項を記録し、システムのアーキテクチャと変更の影響を理解できるようにします。
  • コーディング規約(Spec):命名規則、インターフェースの取り決め、ビジネス上の制約をまとめ、開発、コードレビュー、問題の調査に役立てます。
  • 技術スタック:プロジェクトで使用するフレームワーク、ライブラリ、バージョンを記録し、依存関係の選択と実装を支援します。

ナレッジカードを生成・閲覧する

  1. サイドバーの More から Repo Wiki を選択し、対象のリポジトリを開きます。
  2. Knowledge cards ビューに切り替え、Language で English または 简体中文 を選択します。
  3. Auto Update、Auto Export、Citation の設定を確認し、Generate を選択します。
  4. 左側でカードを検索または選択し、右側で詳細を確認します。
メインブランチ、またはチームが普段使用している開発ブランチでカードを生成してください。Auto Update を有効にすると、コードの変更に応じてカードが増分更新されます。 コードのコミット後、更新操作で変更の影響を受けるナレッジカードを更新できます。進捗を確認し、必要に応じて一時停止して続行します。失敗時は案内に従って再試行し、全体を作り直す場合だけ再生成を選択します。自動更新は Git のコミット差分に基づき、アカウントと組織のポリシーに従います。
Qoder App のナレッジカードビューと概要

タスクでナレッジカードを使用する

Citation を有効にすると、Qoder は同じワークスペース内のタスクでナレッジカードを自動的に使用できます。参照する知識を指示で指定することもできます。たとえば、「注文モジュールのアーキテクチャとコーディング規約を参照して、注文キャンセル API を追加してください」と伝えます。

生成された知識を編集する

対象のワークスペースのタスク入力欄で /knowledge-edit Skill を呼び出し、変更するカードと更新内容を伝えます。設計文書、API ドキュメント、その他の参考資料を提供することもできます。完了後はナレッジカードのページで結果を確認し、Git を通じて共有する場合はエクスポートします。

知識の共有と多言語対応

ナレッジカードは英語(English)と簡体字中国語(简体中文)に対応しています。エクスポートしたファイルは、言語ごとに .qoder/repowiki/knowledge/zh/ または .qoder/repowiki/knowledge/en/ に保存されます。 .qoder/repowiki ディレクトリを Git リポジトリにコミットしてプッシュすると、チームメンバーは git pull でファイルを取得し、インポートできます。チームでの知識共有が利用可能な場合は、More (…) メニューの Pull from team を選択して、チームが公開した知識を取得することもできます。 アカウントと組織のポリシーで許可されている場合、現在のリポジトリ、ブランチ、言語に対応するチームの知識を自動取得できます。必要に応じて、チームから手動で取得する操作も利用できます。

ナレッジカードのインポートとエクスポート

Knowledge Cards Overview ページで More (…) を開きます。
  • Export to .qoder/repowiki:現在のブランチと言語のカードを、プロジェクトルートの .qoder/repowiki/knowledge/ 内にある zh/ または en/ の言語別サブディレクトリに保存します。Auto Export を有効にすると、生成または更新の完了後に自動でエクスポートされます。
  • Import from .qoder/repowiki:プロジェクトルートの .qoder/repowiki/knowledge/ 内にある、対応する言語のサブディレクトリからナレッジカードを読み込み、確認後に現在の対応する内容を置き換えます。Git でファイルを取得した後や、ファイルを手動で編集した後に使用でき、再生成は不要です。
Qoder App のナレッジカードのインポートとエクスポート
ナレッジカードは .qoder/repowiki/knowledge/ に保存され、Wiki ページとは別に管理されます。共有や移動の際は、.qoder/repowiki のディレクトリ構造全体を維持してください。インポートすると、現在のブランチと言語に対応する Wiki ページとナレッジカードが置き換えられます。エクスポートすると対応する言語のディレクトリが上書きされるため、ファイルを手動で編集した場合は、エクスポートする前にインポートしてください。

料金

生成と更新では通常どおり Credits が消費されます。消費履歴は Usage - Credits で確認できます。