Notre avis
Audite la documentation pour détecter les écarts avec le code source, en identifiant les références obsolètes, liens morts et instructions erronées.
Points forts
- Analyse automatisée de la cohérence entre code et documentation.
- Niveaux de sévérité (HIGH, MEDIUM, LOW) pour prioriser les corrections.
- Prise en charge de vérifications ciblées (liens morts, références fichiers) et sortie JSON.
- Mode dry-run pour prévisualiser les correctifs automatiques.
Limites
- Nécessite une configuration initiale via drift init.
- Limité aux artefacts détectables par les vérifieurs existants.
- Peut générer des faux positifs si les chemins de fichiers changent intentionnellement.
Utilisez ce skill avant une release, après un refactoring majeur, ou lorsque l'utilisateur signale une documentation obsolète ou des liens brisés.
Évitez de l'utiliser pour de la documentation externe non liée au code, ou pour des projets sans documentation structurée à auditer.
Analyse de sécurité
SûrThe skill only runs the 'drift' audit tool with Bash, and drift is a documentation checker with no destructive or exfiltration capabilities. No unsafe operations are performed.
Aucun point d'attention détecté
Exemples
Run a full drift audit on the current codebase.Check documentation drift before release, only show medium and high severity issues.Audit documentation for drift since the last merge commit.name: drift-sentinel description: Audits documentation for drift against the code. Use when preparing a release, onboarding someone new, or when the user mentions out-of-date docs. Also use after large refactors to catch stale doc references. allowed-tools:
- Bash(drift *)
When to use this skill
- User says "update the docs" or "check the README" → run
drift audit - Before a release → run
drift audit --max-severity=medium - After a big refactor → run
drift audit --since <last-merge> - User mentions a stale example or broken link → run
drift audit - Need only one kind of check (e.g. dead links) →
drift audit --kind dead-external-link,dead-file-ref - Want machine-readable output for another tool →
drift audit --json(stdout is pure JSON) - Need a clean run without dropping
DRIFT_REPORT.mdin the repo → add--no-report - Discover what verifiers exist →
drift verifiers list - Scaffold a starter config →
drift init
How to interpret results
- HIGH — must fix; users will follow a broken instruction
- MEDIUM — should fix before release
- LOW — nice to have; often acceptable to defer
After running, read DRIFT_REPORT.md (written by default in terminal mode; suppress with --no-report; relocate with --report-path). For auto-fixable items, suggest running drift fix --dry-run first, then drift fix.
Generateur de Documentation API
Documentation
Genere automatiquement de la documentation API OpenAPI/Swagger.
Rédacteur Technique
Documentation
Rédige de la documentation technique claire selon les meilleurs style guides.
Vérification des revendications documentaires
Documentation
Évaluation en lecture seule des affirmations documentaires soutenues par des preuves. Audite les README, notes de version et guides sans exécuter de commandes ni apporter de modifications.