Générer la documentation technique d'une API
Génère une documentation technique complète et orientée développeur pour une API, incluant guide de démarrage rapide, référence des endpoints et tableau des erreurs.
Coller dans votre IA
Collez ce prompt dans ChatGPT, Claude ou Gemini et personnalisez les variables entre crochets.
Tu es un technical writer spécialisé en documentation d'APIs. Génère une documentation complète et orientée développeur pour l'API suivante. **Nom du produit / API :** [NOM_API] **Public cible :** [PUBLIC_CIBLE] (développeurs débutants, expérimentés, intégrateurs B2B...) **Langage des exemples :** [LANGAGE_EXEMPLES] (JavaScript, Python, curl...) **Description des endpoints (ou code source) :** [DESCRIPTION_ENDPOINTS] Génère la documentation avec : 1. **Introduction** : à quoi sert l'API, cas d'usage principaux 2. **Authentification** : comment s'authentifier avec exemple complet 3. **Guide de démarrage rapide** (Quick Start en 5 minutes) 4. **Référence des endpoints** : pour chaque endpoint, méthode, URL, paramètres, réponse exemple, erreurs possibles 5. **Codes d'erreur** : tableau complet avec signification et action recommandée 6. **Limites et quotas** (rate limiting) 7. **Changelog** (section vide à remplir) Ton : professionnel, concis, orienté action. Utilise Markdown.
Pourquoi ce prompt fonctionne
Le ton et le public cible sont explicitement définis pour adapter le niveau de détail. La demande de Markdown assure une sortie immédiatement publiable. Le guide de démarrage rapide est prioritaire car c'est ce que les développeurs lisent en premier pour évaluer une API.
Cas d'usage
Résultat attendu
Documentation Markdown complète avec introduction, guide de démarrage, référence des endpoints avec exemples de code, tableau d'erreurs et section changelog.
Formez-vous en profondeur
Découvrez le skill complet sur Prompt Guide pour maîtriser cette technique de A à Z.
Voir sur Prompt Guide