Communityライティング&編集github.com

mrgnhnt96/impa-review

技術文書とコードを比較し、不整合があれば報告します。修正は行わず、発見事項のみを返します。

impa-review とは?

Impa-review は、技術文書(README、API リファレンス、ガイド、変更履歴、エージェント指示ファイルなど)と、それらが参照するコードの一貫性を検証する AI エージェントスキルです。開発者や AI エージェントが文書に基づいて確実に行動できるかどうかを評価し、不一致や陳腐化した箇所を報告します。主に Claude Code、Cursor、Codex などの開発プラットフォーム上で動作し、ユーザーが文書のレビューや監査、正確性の確認を依頼した際に自動的に起動します。本スキルは修正を一切行わない点が特徴で、発見事項のみを出力し、具体的な修正は別プロセスに委ねます。これにより、文書の正確性を客観的に評価し、開発プロセス全体の信頼性向上に貢献します。

対応✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/mrgnhnt96/impa/tree/HEAD/review

Installed? Explore more ライティング&編集 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

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

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

ドキュメント

Impa review

ロックされた独自セッションで技術文書レビューを開始し、レポートを返します。あらゆる文書に対して、ライターを介さずに動作します。発見事項のみを返し、たとえ「レビューして修正」と依頼されても、文書やコードを編集することはありません。

method.md、checklist.md、および reference/ 内のファイルは読み込まないでください。レビューア自体がそれらを読み込むためであり、これらをこのセッションから除外することが要点です。

このセッションでこれらの文書を作成または変更した場合は、代わりに round.md に従ってください。

手順

  1. ブリーフを "${TMPDIR:-/tmp}"/impa/<project>/direct-<n>/brief-1.md に作成します。<n> は最後のフォルダの1つ上の番号とします。ブリーフには事実のみを記載し、あなたの見解は含めないため、最初に文書を読まないでください。

    impa review メソッドによる技術文書レビュー。ファイルは編集しない。
    
    プロジェクト: <絶対パス>
    文書: <ユーザーが指定した絶対パス、または「find them」>
    その他のソース: <ユーザーが指定した依存関係または兄弟リポジトリの絶対パス、または「none」>
    文書計画: <プロジェクトに .impa/plan.md がある場合の絶対パス、または「none」>
    今回の依頼(ユーザーの言葉で): "<プロンプト>"
    スコープ: <ユーザーが指定した範囲、または「文書セット全体」>
    前回から未解決のもの: なし
    担当者に引き継ぎ: なし
    
    メソッドのレポートを返す。スコープ外であっても、偶然見つけた問題は報告すること。ただし、積極的に探しに行かない。
    
  2. バックグラウンドで起動します。Other sources の各パスに対して --add-dir を追加します。

    impa review --brief <brief> --add-dir <project>
    

    文書セットが大きい場合、--timeout <minutes> が必要になることがあります(デフォルトは20分)。

  3. コマンドが終了コード1で終了した場合、レビューは完了しておらず、review-1.md があれば部分的なものです。review-1.json がない場合、または error が Error: spawn で始まる場合は、起動できませんでした。コマンドの出力を読み、フォールバックを使用してください。それ以外の場合は、より大きな --timeout を指定してもう一度実行します。それでも失敗する場合は、review-1.json の error とともに、レビューが完了しなかったことをユーザーに伝えます。

  4. それ以外の場合は、ブリーフの隣にある review-1.md のみを読みます。そのまま返し、コマンドが出力した行からコストを添えて、停止します。ユーザーから依頼がない限り、発見事項に対してアクションを起こさないでください。修正はこのステップの後の別のステップです。review-1.json の verdict が空の場合、評決行がないため、レポートは信頼できないと伝えます。

impa が PATH にないか起動できない場合は、round.md のセクション3のフォールバックを使用します。それも起動できない場合は、レビューが実行されなかったことをユーザーに伝えます。このセッション内でレビューを実行しないでください。

関連スキル