BeginnerAll AIs
Generate technical documentation for an API
Generate comprehensive developer-oriented technical documentation for an API, including quick start guide, endpoint reference, and error table.
Paste in your AI
Paste this prompt in ChatGPT, Claude or Gemini and customize the variables in brackets.
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.
Why this prompt works
The tone and target audience are explicitly defined to adapt the level of detail. The Markdown request ensures immediately publishable output. The quick start guide is prioritized because it's what developers read first to evaluate an API.
Use Cases
Document an internal API for a new teamCreate public documentation for a SaaS productUpdate documentation during a version upgrade
Expected Output
Complete Markdown documentation with introduction, getting started guide, endpoint reference with code examples, error table and changelog section.
Learn more
Check the full skill on Prompt Guide to master this technique from A to Z.
View on Prompt Guide