/promptCode & devNOUVEAU

README de projet en Markdown

README de projet en Markdown — rendu d’exemple (Claude)
aperçu du rendu

À quoi ça sert

Pour documenter un projet et faciliter sa prise en main.

Aperçu

/prompt · le prompt
Tu es un développeur qui documente proprement ses projets. Rédige un fichier README au format Markdown pour ce projet : [DESCRIPTION DU PROJET]. Inclus une présentation générale, les instructions d'installation, un exemple d'utilisation et […]
aperçu tronqué — débloquez pour tout voir

Mode d’emploi

  1. Copiez le prompt et collez-le dans Claude.
  2. Remplacez les mots entre crochets [ ] par vos propres valeurs.
  3. Lancez la génération — ajustez et relancez autant que vous voulez.

Tout ce qui apparaît entre crochets est une variable à personnaliser.

  • [DESCRIPTION DU PROJET]→ ex. une cuisine ouverte de 20 m², style scandinave

Pourquoi ce prompt fonctionne

Le prompt liste les sections attendues d’un README utile — présentation, installation, usage — plutôt que de laisser le modèle choisir. C’est ce qui évite le README qui décrit longuement l’intention du projet sans jamais dire comment le lancer.

Erreurs fréquentes

  • Décrire le projet sans ses prérequis techniques : la section installation sera fausse.
  • Publier sans vérifier les commandes d’installation, que le modèle invente volontiers.

Exemple de résultat

Un README structuré : présentation, installation, utilisation et contribution.

Dans la même catégorie

Créer un serveur MCP — illustration/skill
Code & dev
GRATUITNOUVEAU

Créer un serveur MCP

Construis des serveurs MCP propres pour connecter une API à un LLM.

gratuit