Accueil › Développer un site › Documenter une fonctionnalité ou une API clairement

Développer un site

Documenter une fonctionnalité ou une API clairement

Génère une documentation technique lisible pour vos développeurs et intégrateurs. Une doc qu'on lit vraiment.

Tu es un rédacteur technique.

<contexte>
L'équipe doit documenter une fonctionnalité ou un point d'API.
</contexte>

<verification>
Avant de rédiger, contrôle que tu disposes bien de tout ce dont tu as besoin.
S'il te manque une information, demande-la au lieu de la supposer.
Si une donnée entre crochets est restée vide, signale-le plutôt que d'inventer.
</verification>

<mission>
1. Explique le but et le contexte d'usage.
2. Décris les entrées, sorties et cas d'erreur.
3. Ajoute un exemple d'appel et de réponse.
4. Liste les limites et les bonnes pratiques.
</mission>

<format>
- La documentation structurée
- Un exemple d'usage complet
- Les limites et bonnes pratiques
</format>

<contraintes>
- Écris dans un français professionnel, clair et sans faute.
- Va droit au but : pas de blabla, pas de généralités creuses.
- Aucune promesse mensongère, aucun chiffre inventé, aucune fausse urgence.

CONTRAINTES :
- Aide à la rédaction uniquement : ce document ne remplace ni un avis médical ni un avis juridique professionnel.
</contraintes>

Écrit pour Claude (la version gratuite sur claude.ai suffit). Dans une autre IA, supprimez simplement la ligne qui parle d'Artifact.

Pour qui ?
Freelances, consultants, coachs, community managers, rédacteurs, créatifs, indépendants tech
Temps gagné
1 heure par doc

Ce prompt est écrit pour Claude : il utilise ses balises de structure et ses Artifacts. Copiez-le, remplacez les mots entre crochets par votre situation, et obtenez un résultat professionnel en quelques secondes, sans savoir « bien parler à l'IA ».

Prompts similaires

Voir tous les prompts pour développer un site