メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.qoder.com/llms.txt

Use this file to discover all available pages before exploring further.

バージョン 1.0.0 以降にのみ適用されます。
ナレッジカード(Knowledge Card)は Repo Wiki と同期して生成される、コードから抽出された高密度の知識ユニットです。Agent が直接消費しやすい形式で、アーキテクチャドキュメント、コード規約(Spec)、技術スタック情報を保存します。また、各コミットプロセスでコードの変更を継続的に追跡し、常に知識のリアルタイム性と正確性を維持します。 ナレッジカード

適用シナリオ

  • アーキテクチャドキュメント主導のシステム理解:構築済みのアーキテクチャドキュメントに基づき、Agent はコードベースを繰り返し検索することなく、「このモジュールの全体的な設計方針は何ですか?」や「各サービス間の依存関係はどうなっていますか?」といった質問にすばやく回答できます。
  • コード規約(Spec)に基づく開発タスク:コードスタイル、インターフェース設計、またはビジネスロジックがチームの標準に準拠しているか確認する必要がある場合、Agent は規約知識を直接参照して判断を下すことができます。以下のシナリオをサポートします:
    • 機能追加時に命名規則やインターフェースの取り決めに自動的に準拠
    • コードレビュー時に実装が規約要件を満たしているか迅速に確認
    • バグ修正時に規約に違反する潜在的なリスクを特定
  • 技術スタック知識による技術的な意思決定の加速:Agent は事前設定された技術スタック情報を組み合わせることで、コンテキストが限られた状況や、言語・フレームワークをまたぐシナリオで、以下のタスクを効率的にサポートします:
    • 新しい依存関係を導入する際の互換性の評価
    • 現在の技術スタックのスタイルに一致するコードスニペットの生成
    • 「現在のプロジェクトではどのフレームワークとバージョンが使用されていますか?」などの技術環境に関する質問への回答

ナレッジカードの種類

  • アーキテクチャドキュメント モジュールの全体的な設計概念、サービス間の依存関係、および重要な決定を記録し、Agent がコードを一行ずつ読まなくてもシステムの全貌を理解できるようにします。
  • コード規約(Spec) チームのコーディング標準、命名規則、インターフェースの取り決め、およびビジネスロジックの制約を蓄積し、Agent がコードを生成する際に自動的にチームの標準に準拠するようにします。
  • 技術スタック プロジェクトで使用されているフレームワーク、ライブラリ、およびバージョン情報を記録し、Agent が新しい依存関係を導入したりコードスニペットを生成したりする際に、現在の技術環境に一致した決定を下せるようにします。

ナレッジカードの生成

プロジェクトの中心となるコンテンツをカバーするために、メインブランチとコア開発ブランチを選択して生成することをお勧めします。生成プロセス中、完了したカードはすべてが完了するのを待つことなくリアルタイムでプレビューできます。
生成の推奨事項:Agent が最も重要なビジネスロジックとコード構造を確実に理解できるように、メインブランチ(main / master)およびチームでよく使用される開発ブランチで優先的にナレッジカードを生成してください。

知識の共有と多言語対応

チーム内での知識の流動性を高めるために、ナレッジカードの共有をサポートしています。 ローカルでナレッジカードを生成すると、システムはコードリポジトリの専用ディレクトリ(.qoder/repowiki)にデータを自動的に保存します。このディレクトリをコミットし、リモートブランチにプッシュできます。チームメンバーは追加の構成なしで、git pull を介して生成されたナレッジカードのコンテンツを取得できます。 さらに、ナレッジカードは多言語をサポートしています。生成時に希望する言語を選択できます(現在、英語中国語がサポートされています)。言語の選択に基づいて、システムは言語ごとの独立したサブディレクトリ(例:zh/en/)を自動的に作成します。

課金

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