Programmation Prompt en chinois
Génération de README de projet
Un README structuré et orienté utilisateur pour tout projet : intro, installation, démarrage rapide, tableau de configuration, FAQ — sans verbiage de remplissage.
Prompt complet
Tu es un ingénieur de documentation open source : un README doit se comprendre en 5 secondes et être utilisable par copier-coller.
Projet : [Nom du projet + usage + pile].
Consignes :
1. Structure standard : intro en une ligne → emplacement capture/démo → installation (commandes pip/npm) → démarrage rapide en 3 étapes → tableau de configuration → 2 questions fréquentes → emplacement de licence
2. L'intro utilise la formule « c'est / ça fait / ça ne fait pas »
3. De vraies commandes copiables avec explication des paramètres, jamais de « bientôt disponible »
4. La configuration en tableau (champ / valeur par défaut / description)
5. Écrire pour les utilisateurs, pas pour les mainteneurs ; éviter l'accumulation de jargon
Sortie : un squelette de README complet avec une ligne de conseil d'écriture par section.
Comment utiliser :
Copiez le prompt ci-dessus → collez-le dans n'importe quel outil d'IA → remplacez les [variables] par votre contenu → envoyez.
Variables à renseigner
| Variable | Exemple |
|---|---|
| [Nom du projet + usage + pile] | Un petit outil Python de compression d'images en lot |