Communitygithub.com

プロジェクト知識ベース管理スキル

Codexやその他のコーディングエージェントが、プロジェクトレベルの知識ベースを初期化、維持、発展させるための再利用可能なエージェントスキルです。

プロジェクト知識ベース管理スキル とは?

このスキルは、AIコーディングエージェントがプロジェクトの知識ベースを体系的に管理するための再利用可能なスキルです。Codex、Claude Code、Cursor、Gemini CLIなど、プロジェクトファイルを読み取り、リポジトリローカルの指示に従える任意のエージェントで使用できます。主な機能として、プロジェクトの目的、アーキテクチャ、API、技術的決定、バグ履歴、変更履歴を構造化されたマークダウンファイル(AGENTS.md、knowledge/ディレクトリ以下)に記録し、将来のセッションで再発見を不要にします。セッション終了時には、更新されたファイルと未検証の項目を簡潔に報告します。知識の腐敗を防ぐため、重複や古い内容の統合、安定した事実のみを保持するルールに従います。

対応✓Claude Code✓Codex CLI✓Cursor✓Gemini CLI
npx skills add chancy24/codex-knowledge-base-skill

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

プロジェクト知識ベース管理スキル は何をしますか?

目的

このスキルを使用して、AIコーディングエージェント向けのプロジェクトレベルの知識ベースを初期化、維持、発展させます。知識ベースは、将来のエージェントセッションがプロジェクトの目的、アーキテクチャ、インターフェース、決定事項、バグ、最近の変更を、ゼロから再発見することなく理解するのに役立ちます。

ワークフローはツールに依存しないようにしてください。Codex、Claude Code、Cursor、Gemini CLI、その他プロジェクトファイルを読み取り、リポジトリローカルの指示に従えるコーディングエージェントで使用可能であるべきです。

使用タイミング

ユーザーが以下を依頼した場合にこのスキルを使用します。

  • プロジェクト知識ベースの初期化
  • プロジェクトの要約または文書化
  • バグ修正と修正経験の保存
  • 機能の追加または変更
  • API、スキーマ、コマンド、データ形式の追加または変更
  • 技術的な決定やトレードオフの記録
  • 生のプロジェクト資料を構造化された知識に整理
  • 完了した開発セッションのレビューまたは振り返り
  • AGENTS.md または knowledge/ 以下のファイルの更新

入力

一般的な入力には以下が含まれます。

  • 現在のリポジトリまたは対象プロジェクトのパス
  • 既存のプロジェクトファイル、ソースコード、ドキュメント、課題、ログ、または生の資料
  • ユーザーの現在のタスクと、セッション中に行われた実装変更
  • 存在する場合、既存の AGENTS.md、knowledge/、raw/、または skills/ の内容

出力

期待される出力には以下が含まれます。

  • AGENTS.md プロジェクトルール
  • knowledge/overview.md プロジェクト概要
  • knowledge/business.md ビジネスロジックと使用シナリオ
  • knowledge/architecture.md システムアーキテクチャとデータフロー
  • knowledge/api.md インターフェース、スキーマ、コマンド、データ構造
  • knowledge/decisions.md 技術的決定とトレードオフ
  • knowledge/bugs.md バグ履歴、根本原因、修正、予防ルール
  • knowledge/changelog.md セッションレベルの変更記録
  • オプションの raw/ フォルダとプロジェクトローカルの skills/ フォルダ
  • 何が更新され、何をまだ検証する必要があるかを示す短い最終レポート

ワークフロー

  1. 最初にプロジェクトルールを読みます。
    • 存在する場合 AGENTS.md
    • knowledge/overview.md
    • knowledge/architecture.md
    • knowledge/decisions.md
    • knowledge/bugs.md
  2. リポジトリを初期化する場合は、references/templates/ のテンプレートを使用するか、このパッケージの初期化スクリプトを実行します。
  3. 現在のタスクを理解し、何が変更されたかを特定します。
    • プロジェクトの目標またはビジネスロジック
    • アーキテクチャまたはモジュールの境界
    • API、コマンド、データファイル、スキーマ、または戻り値の構造
    • バグの症状、根本原因、修正、または予防ルール
    • 技術的な決定またはトレードオフ
    • ユーザー向け動作またはUIの規約
  4. 関連するナレッジファイルのみを更新します。
  5. 重複、古い、または矛盾した内容を削除または調整します。
  6. 重要な作業の後は必ず knowledge/changelog.md を更新します。
  7. 更新されたファイルと不足している検証を報告します。

より詳細なメンテナンスガイダンスについては、references/playbook.md を参照してください。

knowledge/ の更新

変更に最も適した最小のファイルを使用します。

  • プロジェクトの目的、スコープ、主要モジュール、主要出力については overview.md を更新します。
  • ユーザーシナリオ、ワークフロー、ドメインルール、安全境界については business.md を更新します。
  • モジュール関係、データフロー、実行モード、統合境界については architecture.md を更新します。
  • エンドポイント、関数、コマンド、イベント、データファイル、スキーマ、戻り値の構造については api.md を更新します。
  • 意味のある技術的選択とトレードオフについては decisions.md を更新します。
  • 確認されたバグと学んだ教訓については bugs.md を更新します。
  • 重要なタスクの要約ごとに changelog.md を更新します。

一時的な推論を知識ベースにダンプしないでください。安定した事実、検証された決定、再利用可能な教訓を優先します。

バグの振り返り

バグが修正されたら、knowledge/bugs.md を次の項目で更新します。

  • 問題の症状
  • 根本原因
  • 修正
  • 影響範囲
  • 実施した検証
  • 再発防止のルール

根本原因が不明な場合は、推測する代わりに保留中とマークします。

インターフェースの変更

API、コマンド、関数、スキーマ、CSV、イベント、またはファイル形式が変更された場合、knowledge/api.md を次の項目で更新します。

  • インターフェース名
  • リクエストメソッドまたは呼び出し形式
  • パス、コマンド、関数名、またはファイルパス
  • 入力とパラメータ
  • 応答または出力形式
  • 注意事項、制約、および例

正確な名前とフィールドの綴りを使用します。

技術的決定

意味のある技術的選択が行われた場合、knowledge/decisions.md を次の項目で更新します。

  • 決定の背景
  • 検討したオプション
  • 最終的な選択
  • 選択の理由
  • 結果とフォローアップ作業

将来のエージェントが解決済みの問題を再検討するのを防ぐのに役立つ決定を記録します。

知識の腐敗を防ぐ

  • 既存のエントリにほぼ重複するエントリを追加するよりも、既存のエントリを編集することを優先します。
  • 古い内容は「差し替え済み」とマークするか、現在の事実に置き換えます。
  • プロジェクトの事実を推測と分離します。
  • 決定、バグ、チェンジログエントリには日付を使用します。
  • 特定のツール統合にツール固有のメモが必要でない限り、文言はエージェントに中立に保ちます。
  • ユーザーが作成したプロジェクトルールを明示的なリクエストなしに上書きしないでください。

最終応答

最終応答は簡潔に保ちます。以下を含めます。

  • 更新されたファイル
  • 実施した検証
  • 残っている手動チェック

関連スキル