readiness-report

エージェント対応状況レポート

リポジトリが自律的な AI 支援開発をどの程度サポートしているかを評価します。

このレポートでできること

AI エージェントがリポジトリ内で効果的に作業できるかどうかを左右する、5 つの柱に基づいてコードベースを評価します。出力される構造化レポートでは、備わっているものと不足しているものを特定します。

5 つの柱

柱	問い	特徴
エージェント向けの指示	エージェントは何をすればよいか把握していますか？	18
フィードバックループ	エージェントは結果が正しいか把握できますか？	16
ワークフローと自動化	プロセスはエージェントの作業をサポートしていますか？	15
ポリシーとガバナンス	エージェントはルールを把握していますか？	13
ビルドと開発環境	エージェントはプロジェクトをビルドして実行できますか？	12

特徴は合計 74 個です。説明と証拠の例を含む一覧は、references/criteria.md を参照してください。

実行方法

ステップ 1：スキャナースクリプトを実行する

5 つのシェルスクリプトで、ファイルの存在、設定パターン、ディレクトリ構造などのファイルシステム上の情報を収集します。これにより、何があるかを明らかにできるため、何十もの find コマンドを手動で実行する必要はありません。

bash scripts/scan_agent_instructions.sh /path/to/repo
bash scripts/scan_feedback_loops.sh /path/to/repo
bash scripts/scan_workflows.sh /path/to/repo
bash scripts/scan_policy.sh /path/to/repo
bash scripts/scan_build_env.sh /path/to/repo

5 つすべてをまとめてスキャンすることもできます。

for s in scripts/scan_*.sh; do bash "$s" /path/to/repo; echo; done

重要：スクリプトは補助ツールであり、採点を行うものではありません。ファイルやパターンを見つけますが、品質は評価しません。README に実際のビルドコマンドが記載されているか、それともバッジだけなのか、インラインドキュメントが体系的に整備されているか、それとも散在しているか、AI の利用ポリシーに意味のある制限があるかなど、多くの特徴の評価には、実際のファイルを読んで初めてできる判断が必要です。

ステップ 2：各特徴を評価する

references/criteria.md を柱ごとに確認します。各特徴について、次の手順を行います。

1. スキャナーの出力から関連する情報を確認します
2. スキャナーだけでは十分に評価できない特徴については、ファイルを自分で確認します
3. 各特徴に、✓（あり）、✗（なし）、—（該当なし）のいずれかを付けます

判断が必要な特徴（スキャナーだけでは十分に評価できないもの）：

• README に実際のビルド／実行／テスト用コマンドが記載されていますか？（単にファイルが存在するだけではありません）
• インラインドキュメントは公開 API 全体にわたって体系的に整備されていますか？
• サンプルは実際に実行できますか？
• コントリビューションガイドにコーディング規約が記載されていますか？
• 意味のある AI 利用ポリシーがありますか？
• アーキテクチャのドキュメントは最新ですか？
• エージェントがテストを実行できるだけの情報が記載されていますか？

ステップ 3：レポートを作成する

次の形式で出力を構成します。

# Agent Readiness Report: {repo name}

## Summary
- Features present: X / 74
- Strongest pillar: {pillar}
- Weakest pillar: {pillar}

## Pillar 1 · Agent Instructions (X / 18)
✓ Agent instruction file — AGENTS.md at root
✓ AI IDE configuration — .cursor/rules/ with 3 rule files
✗ Multi-model support — only Cursor configured
...

## Pillar 2 · Feedback Loops (X / 16)
...

## Pillar 3 · Workflows & Automation (X / 15)
...

## Pillar 4 · Policy & Governance (X / 13)
...

## Pillar 5 · Build & Dev Environment (X / 12)
...

評価に合格した特徴ごとに、見つかった証拠を簡潔に記載します。 評価に不合格だった特徴ごとに、不足しているものを記載します。

これらの特徴が役立つ理由

すべての特徴は、次の問いに答えます。これがない場合、AI エージェントにどのような問題が起きるでしょうか？ 「エージェント向け指示ファイル」や「ツールサーバー設定」といった特徴があるのは、エージェントに必要だからです。「リンター」や「CI パイプライン」といった特徴があるのは、エージェントが変更の正しさをすばやく明確に確認できるフィードバックを必要とするからであり、一般的なベストプラクティスだからではありません。

評価基準は、AI 対応状況の 5 つのカテゴリにまたがる実際のリポジトリ 123 件の分析から導き出され、エージェントの有効性に実際に影響する特徴に絞り込まれています。

---

クレジットと帰属

このスキルは、OpenHands による優れた取り組みを基にしています。

元のリポジトリ：https://github.com/OpenHands/skills

このスキルコレクションの形成に貢献した、寛大なオープンソースの貢献を行った OpenHands に、心より感謝します。 このスキルコレクション向けに webconsulting.at が改変しました