Community寫作與編輯github.com

mrgnhnt96/impa-review

審查技術文件是否與其所描述的程式碼一致,回報不一致之處,並判斷開發者或 AI 代理是否能據以行動。僅回報發現結果,絕不進行任何修正。

impa-review 是什麼?

「Impa 審查」是一項專門用於針對技術文件與實際程式碼進行一致性檢查的技能。其核心功能是啟動一個獨立的審查會話,深入分析文件內容與程式碼實作之間的差異,並產出詳盡的報告。這項技能特別強調「只回報、不修正」的原則,確保審查結果的客觀性,使用者可以根據報告自行決定後續的修復行動。此技能支援多種平台,包含 Claude Code、Cusor 和 Codex 等常見的 AI 代理工具。當使用者要求審閱、稽核、檢查 README、技術文件、API 參考指南、更新日誌或 AI 代理指令文件,或是詢問文件是否準確、過時或與程式碼匹配時,都應觸發此技能。它會自動啟動一個背景審查流程,透過寫入簡報文件並呼叫 `impa review` 指令來執行。該技能設計用於處理任何類型的技術文件,無需文件作者的直接參與。如果審查指令執行失敗,它會提供明確的錯誤訊息和備用方案(fallback),確保使用者能獲得最終的審查結果或明確的失敗通知。這項技能的設計讓開發者與 AI 代理能夠快速且可靠地掌握文件與程式碼之間的漂移狀況,是維護技術文件準確性的強大工具。

相容平台✓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 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

Impa 審查

在獨立的鎖定會話中啟動技術文件審查,並回傳報告。適用於任何文件,無需作者參與。僅回報發現結果:即使被要求「審查並修正」,它也絕不會編輯文件或程式碼。

請勿讀取 method.md、checklist.md 或 reference/ 中的任何內容。審查工具會自行載入它們,將它們排除在此會話之外正是其關鍵所在。

如果您在此會話中撰寫或修改了這些文件,請遵循 round.md 中的步驟。

步驟

  1. 將簡報寫入 "${TMPDIR:-/tmp}"/impa/<專案>/direct-<n>/brief-1.md,其中 <n> 是上一個資料夾編號加一。此檔案僅記錄事實,絕不包含您的觀點,因此請勿事先閱讀文件:

    使用 impa 審查方法審查技術文件。請勿編輯任何檔案。
    
    專案:<絕對路徑>
    文件:<使用者指定的絕對路徑,或「自行尋找」>
    其他來源:<使用者指定的依賴或同級儲存庫的絕對路徑,或「無」>
    文件計畫:<專案中 .impa/plan.md 的絕對路徑,或「無」>
    本次任務要求(使用使用者的話):"<提示>"
    範圍:<使用者指定的範圍,或「整個文件集」>
    上次任務遺留的未解決問題:無
    已移交給人員:無
    
    回傳該方法的報告。如果發現任何超出範圍的問題,請提及,但不要刻意尋找。
    
  2. 在背景啟動審查。為「其他來源」下的每個路徑添加 --add-dir:

    impa review --brief <簡報> --add-dir <專案>
    

    大型文件集可能需要 --timeout <分鐘>,預設為 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 節中的備用方案。如果該備用方案也無法啟動,請告知使用者未執行任何審查。絕不要在此會話中進行審查。

相關技能