Synthèse automatique
Évalue la qualité d'une documentation d'API en la confrontant au code réel : complétude des endpoints, exactitude des paramètres et des réponses, exemples utilisables et présence d'une spécification lisible par machine.
Points forts
- Grille d'évaluation structurée couvrant complétude, exactitude, expérience développeur et specs machine
- Comparaison explicite entre la documentation et l'implémentation pour repérer paramètres fantômes ou non documentés
- Vérification des exemples de réponse par rapport à la forme réelle et des codes d'erreur avec leur cause
- Sortie actionnable avec notation, liste des endpoints non documentés et recommandations concrètes
Limites
- Suppose que l'agent a accès à la fois à la doc et au code source pour l'étape d'exactitude
- Ne valide pas la spec OpenAPI/GraphQL par outillage (lint, validation de schéma), seulement sa présence et sa cohérence
- Pas de conseils sur la rédaction ou la style éditorial au-delà des critères listés
À utiliser lors d'une revue de documentation d'API avant publication ou après un changement d'endpoints, quand la doc et le code doivent être réalignés.
À éviter pour rédiger une documentation from scratch ou pour évaluer une documentation produit non technique, hors périmètre API.
Analyse de sécurité
SûrThis is a pure instructional checklist for reviewing API documentation quality. It declares no tools, executes no code, touches no network or filesystem, and contains no destructive, exfiltrating, or obfuscated instructions. The only implicit action is reading documentation and comparing it to source code, which is benign review work.
Aucun point d'attention détecté
Comment cette analyse est faiteExemples
Review the API documentation in docs/api/ against the route handlers in src/routes/. Rate its quality, list undocumented endpoints, flag any parameter or response examples that don't match the code, and give me concrete fixes.Check whether our openapi.yaml is kept in sync with the implementation. Flag endpoints, parameters, or status codes that appear in one but not the other.Pretend you're a developer integrating with our API for the first time using only the docs. Tell me where the quickstart breaks down, which examples lack a response, and which error codes are unexplained.name: api-documentation-review description: Evaluate API documentation quality — completeness, accuracy, examples, and developer experience.
Instructions
You are evaluating the quality of API documentation. Good API docs enable developers to integrate without reading source code.
Completeness Check
For every public endpoint or method:
- Is the endpoint documented?
- Are request parameters documented (path, query, header, body) with types and required/optional status?
- Is the response structure documented for all status codes (success AND error)?
- Are authentication requirements stated?
- Are rate limits documented?
Accuracy Check
- Compare documentation against the actual implementation.
- Flag documented parameters that do not exist in the code.
- Flag undocumented parameters that exist in the code.
- Flag response examples that do not match the actual response shape.
- Flag documented behavior that contradicts the implementation.
Developer Experience
- Are there working examples for common use cases?
- Do examples include request AND response (not just one side)?
- Is there a "quickstart" section that gets a developer from zero to a successful API call?
- Are error responses documented with explanations of what causes each error and how to fix it?
- Is the documentation searchable and well-organized?
Machine-Readable Specs
- Verify an OpenAPI (Swagger), GraphQL schema, or protobuf definition exists.
- Check that the spec is auto-generated or kept in sync with the code.
- Flag specs that are manually maintained and likely to drift.
- Verify the spec is published and accessible to consumers.
Output
- Rate documentation quality: Excellent / Adequate / Incomplete / Missing.
- List undocumented endpoints.
- List inaccuracies between docs and implementation.
- Provide specific improvement recommendations.
Du fichier au premier essai
Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.
Consulter la source et ses fichiers annexesCe téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.
1. Télécharger le fichier
Télécharger SKILL.mdDepuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/api-documentation-review-mrzxuqgz/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.
Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.
mkdir -p '.skill-downloads/api-documentation-review-mrzxuqgz' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/api-documentation-review-mrzxuqgz/download' --output '.skill-downloads/api-documentation-review-mrzxuqgz/SKILL.md.part' && mv '.skill-downloads/api-documentation-review-mrzxuqgz/SKILL.md.part' '.skill-downloads/api-documentation-review-mrzxuqgz/SKILL.md'2. Vérifier les prérequis
Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.
Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.
Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.
3. Charger la skill
Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.
Claude Code
test -f '.skill-downloads/api-documentation-review-mrzxuqgz/SKILL.md' && test -s '.skill-downloads/api-documentation-review-mrzxuqgz/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/api-documentation-review' && cp -R '.skill-downloads/api-documentation-review-mrzxuqgz' '.claude/skills/api-documentation-review'Cursor
test -f '.skill-downloads/api-documentation-review-mrzxuqgz/SKILL.md' && test -s '.skill-downloads/api-documentation-review-mrzxuqgz/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/api-documentation-review' && cp -R '.skill-downloads/api-documentation-review-mrzxuqgz' '.cursor/skills/api-documentation-review'Codex
test -f '.skill-downloads/api-documentation-review-mrzxuqgz/SKILL.md' && test -s '.skill-downloads/api-documentation-review-mrzxuqgz/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/api-documentation-review' && cp -R '.skill-downloads/api-documentation-review-mrzxuqgz' '.agents/skills/api-documentation-review'OpenSkills
OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.
Installation officielle d’OpenSkillsopenskills install './.skill-downloads/api-documentation-review-mrzxuqgz'openskills read 'api-documentation-review-mrzxuqgz'La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.
Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.
openskills syncMode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.
4. Faire un premier essai
Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :
Lis .skill-downloads/api-documentation-review-mrzxuqgz/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.
Rédaction de docs Supabase
Documentation
Rédigez, éditez et révisez le contenu de la documentation Supabase : guides, tutoriels, références et partiels. Suivez les guides de style et les règles de validation MDX/TOML.
Créer un enregistrement de décision d'architecture
Documentation
Créer un nouveau ADR avec numérotation séquentielle, l'enregistrer dans le graphe AgentDB et le lier aux ADR associés.
Mise à jour de plan avec recherche approfondie
Documentation
Met à jour un document de plan en lançant des sous-agents en parallèle pour analyser un sujet sur tous les passes du compilateur, puis consolide les résultats.