CommunityRédaction et éditiongithub.com

mrgnhnt96/impa-review

Analyse les documentations techniques par rapport au code qu'elles décrivent et signale les incohérences, en indiquant si un développeur ou un agent peut agir dessus. Rapporte uniquement les résultats, sans jamais corriger.

Qu'est-ce que impa-review ?

Impa-review est un outil d'audit de documentation technique conçu pour comparer des documents (README, guides, API, CLI, changelogs, instructions d'agent) avec le code réel et identifier les écarts. Il génère un rapport listant les incohérences, précise si un humain ou un agent peut les corriger, mais n'effectue jamais de modification. La skill lance une session verrouillée, invoque la commande `impa review` avec un brief structuré et retourne le rapport généré. Elle supporte les projets avec ou sans plan `.impa/plan.md`, permet d'ajouter des dépendances via `--add-dir`, et ajuste le temps d'analyse via `--timeout`. En cas d'échec, elle propose un repli défini dans `round.md`. Cette skill est idéale pour toute demande de vérification, d'audit ou de détection de dérive documentaire.

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

Installed? Explore more Rédaction et édition skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

Demander à votre IA préférée

Ouvre une nouvelle conversation avec cette compétence d'agent déjà préchargée.

Documentation

Revue Impa

Lance une revue de documentation technique dans sa propre session verrouillée et retourne le rapport. Fonctionne sur n'importe quelle documentation, sans intervention humaine. Résultats uniquement : ne modifie jamais la documentation ni le code, même si on lui demande de « revoir et corriger ».

Ne pas lire method.md, checklist.md ni quoi que ce soit dans reference/. Le réviseur les charge lui-même, et les laisser hors de cette session est le principe.

Si vous avez écrit ou modifié ces documents dans cette session, suivez plutôt round.md.

Étapes

  1. Écrire le brief dans "${TMPDIR:-/tmp}"/impa/<projet>/direct-<n>/brief-1.md, avec <n> supérieur d'un au dernier dossier présent. Il contient des faits et jamais votre avis, donc ne lisez pas la documentation d'abord :

    Examiner la documentation technique selon la méthode de revue Impa. Ne modifier aucun fichier.
    
    Projet : <chemin absolu>
    Documents : <chemins absolus nommés par l'utilisateur, ou "les trouver">
    Autres sources : <chemins absolus des dépendances ou dépôts frères nommés par l'utilisateur, ou "aucune">
    Plan documentation : <chemin absolu vers .impa/plan.md si le projet en a un, ou "aucun">
    Demande de ce tour, dans les mots de l'utilisateur : "<prompt>"
    Périmètre : <ce que l'utilisateur a nommé, ou "l'ensemble du jeu de documents">
    Encore ouvert du tour précédent : aucun
    Transmis à une personne : aucun
    
    Retourner le rapport de la méthode. Signaler tout problème hors périmètre que vous remarquez, mais sans le chercher.
    
  2. Lancer en arrière-plan. Ajouter --add-dir pour chaque chemin sous Autres sources :

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

    Un jeu de documents volumineux peut nécessiter --timeout <minutes>, dont la valeur par défaut est 20.

  3. Si la commande se termine avec le code 1, la revue n'est pas terminée, et tout review-1.md est partiel. Sans review-1.json, ou avec une error commençant par Error: spawn, elle n'a pas pu démarrer : lisez ce que la commande a affiché, puis utilisez la solution de repli. Sinon, relancez-la avec un --timeout plus grand. Si cela échoue aussi, indiquez à l'utilisateur qu'aucune revue n'a abouti, avec l'error de review-1.json.

  4. Sinon, lisez uniquement review-1.md, à côté du brief. Retournez-le tel quel, avec le coût de la ligne imprimée par la commande, et arrêtez-vous. N'agissez pas sur les résultats sauf demande de l'utilisateur : la correction est une étape séparée, après celle-ci. Si verdict est vide dans review-1.json, il n'y a pas de ligne de verdict, donc dites que le rapport n'est pas fiable.

Si impa n'est pas dans le PATH ou ne peut pas démarrer, utilisez la solution de repli dans la section 3 de round.md. Si celle-ci ne peut pas non plus démarrer, dites à l'utilisateur qu'aucune revue n'a été exécutée. Ne jamais revoir dans cette session.

Skills associés