Points clés
- Tout prompt de production nécessite au minimum une fiche one-liner (objectif, modèle, date, auteur)
- Tout prompt modifié nécessite un bloc de version (ce qui a changé, pourquoi, résultat de test)
- Tout prompt testé nécessite un en-tête de suite de tests
- Stocker la documentation au même endroit que le prompt
- La justification du changement (« pourquoi ») est le champ le plus important
Pourquoi les prompts non documentés font échouer les équipes
📍 In One Sentence
Les prompts non documentés font échouer les équipes par régression silencieuse, duplication et perte de connaissances — chacun évitable avec 5 à 10 minutes de documentation par prompt.
💬 In Plain Terms
Quand un prompt n'a aucune trace de ce qu'il fait ou pourquoi il a été écrit ainsi, l'équipe ne peut pas le modifier en toute sécurité, le récupérer après une édition, ou le transmettre à un nouveau membre sans contexte.
Les prompts non documentés font échouer les équipes de trois façons : régression silencieuse, duplication et perte de connaissances. Chaque échec est évitable avec 5 à 10 minutes de documentation par prompt.
L'échec le plus coûteux est la régression silencieuse. Une équipe modifie un prompt de production, casse inadvertamment autre chose, et n'a pas de référence pour comparer.
Documentez chaque prompt utilisé plus d'une fois, stocké dans une infrastructure partagée ou déployé en production.
⚠️ Risque de régression silencieuse
Sans bloc de version et exemples golden, une équipe modifiant un prompt de production n'a pas de référence. Chaque modification est une supposition sur l'état précédent.
6 modèles de documentation des prompts
Six modèles couvrent l'intégralité du cycle de vie des prompts. Chaque modèle est conçu pour être complété en moins de 10 minutes.
- 1Fiche one-liner
Why it matters: Objectif : enregistrement minimum pour tout prompt réutilisé. Champs : nom du prompt, objectif (1 phrase), modèle cible, date de création, auteur. - 2Bloc de version
Why it matters: Objectif : suivre l'historique du prompt. Champs : numéro de version, date de modification, auteur, ce qui a changé (1 phrase), raison du changement (1 phrase), résumé des résultats de test. - 3En-tête de suite de tests
Why it matters: Objectif : définir les critères d'acceptation avant d'écrire les tests. Champs : objectif du test, critères de réussite, exemples golden (2–3 paires entrée/sortie), modes d'échec connus. - 4Journal de décision
Why it matters: Objectif : enregistrer les décisions de conception non évidentes. Champs : décision prise, alternatives considérées, raison du choix, date. - 5Justification de changement
Why it matters: Objectif : expliquer pourquoi un prompt a été modifié. Champs : énoncé du problème, changement effectué, amélioration attendue, résultat mesuré. - 6Bloc de configuration API
Why it matters: Objectif : enregistrer les paramètres du modèle en production. Champs : modèle, température, max tokens, top_p, séquences d'arrêt, version du system prompt, version du user prompt.
📌 Guide de sélection des modèles
Nouveau prompt → Fiche one-liner. Prompt modifié → Bloc de version. Prompt testé → En-tête de suite de tests. Décision de conception prise → Journal de décision. Modifié après échec → Justification de changement. Déployé en production → Bloc de config API.
Où stocker la documentation des prompts
Stockez la documentation des prompts dans le même système que le prompt.
- Git : idéal pour les équipes d'ingénierie avec des prompts stockés comme fichiers. Les messages de commit servent de blocs de version. Gratuit.
- PromptHub : gestion des prompts avec historique des versions, signatures des réviseurs et stockage des résultats de tests.
- Notion : pour les équipes gérant les prompts comme des documents. Facile à configurer, manque de contrôle de version.
- Braintrust : stocke les en-têtes de suite de tests et les résultats d'évaluation avec les versions de prompts.
💡 Colocaliser la documentation
La documentation stockée dans un système séparé (Notion, Confluence, Google Docs) du prompt deviendra obsolète en quelques jours. Seule la documentation qui vit avec le prompt reste à jour.
Erreurs courantes de documentation
❌ Aucune documentation
Why it hurts: Les prompts ne peuvent pas être récupérés après modifications, l'équipe ne comprend pas pourquoi un prompt a été écrit d'une certaine façon
Fix: Utiliser au minimum la fiche one-liner — 3 champs, moins de 2 minutes
❌ Documentation stockée séparément du prompt
Why it hurts: La documentation devient obsolète quand les prompts changent ; les équipes oublient de la mettre à jour
Fix: Stocker la documentation dans le même fichier ou commit Git que le prompt
❌ Champ « pourquoi » manquant — décrit seulement ce que fait le prompt
Why it hurts: Les futurs éditeurs ne connaissent pas les contraintes, ne peuvent pas refactoriser en toute sécurité
Fix: Ajouter un champ « justification » à chaque modèle : 1 à 2 phrases expliquant pourquoi cette structure a été choisie
❌ Pas de bloc de version
Why it hurts: Impossible de savoir si le prompt en production correspond à la version documentée
Fix: Ajouter version et dateModified à chaque fichier de prompt de production
Questions fréquentes
Pourquoi les prompts ont-ils besoin de documentation ?
Les prompts sans documentation ne peuvent être ni révisés, ni audités, ni reproduits. L'équipe ne peut pas diagnostiquer les régressions ni revenir à une version fonctionnelle.
Quelle est la documentation minimale ?
Le minimum est une fiche one-liner : objectif, modèle cible, date de création, auteur. Cela prend 2 minutes.
Où stocker la documentation ?
Au même endroit que le prompt. Git pour les fichiers de code, PromptHub pour la gestion structurée avec historique.
Quel modèle pour un nouveau prompt ?
Commencez par la fiche one-liner. En production → Bloc de version. Tests multiples → En-tête de suite de tests. Décision non évidente → Journal de décision.
À quelle fréquence mettre à jour ?
À chaque modification du texte du prompt. Ajoutez version et justification pour chaque changement substantiel.
Puis-je utiliser ces modèles dans PromptHub ?
Oui. PromptHub correspond directement aux champs des modèles Bloc de version et Bloc de config API.