What is the difficulty level and which AI tool should I use?

This prompt is beginner level. It works with all AI tools (ChatGPT, Claude, Gemini, etc.).

BeginnerAll AIs

Generate Technical API Documentation

Generates complete, developer-oriented technical documentation for an API, including quickstart 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 :

Introduction : à quoi sert l'API, cas d'usage principaux
Authentification : comment s'authentifier avec exemple complet
Guide de démarrage rapide (Quick Start en 5 minutes)
Référence des endpoints : pour chaque endpoint, méthode, URL, paramètres, réponse exemple, erreurs possibles
Codes d'erreur : tableau complet avec signification et action recommandée
Limites et quotas (rate limiting)
Changelog (section vide à remplir)

Ton : professionnel, concis, orienté action. Utilise Markdown.

Personalize this prompt with Léa

Answer 3 questions and Léa tailors the prompt to your situation.

Why this prompt works

The tone and target audience are explicitly defined to adapt the level of detail. Requesting Markdown ensures immediately publishable output. The quickstart guide is prioritized because it is what developers read first to evaluate an API.

Use Cases

Documenting an internal API for a new teamCreating public documentation for a SaaS productUpdating documentation during a version upgrade

Expected Output

Complete Markdown documentation with introduction, quickstart guide, endpoint reference with code examples, error table and changelog section.

Improve this prompt

Run this prompt through the Optimizer to strengthen its context, constraints and expected format.

Improve this prompt with the Optimizer

Comments

LéaAI
Ajoutez dans la section "Authentification" un exemple de flux d'erreur (token expiré, refresh) avec la réponse HTTP réelle. Les développeurs gagneront du temps en débuguant.