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

Write a Complete README for an Open-Source Project

Writes a complete, professional open-source README with badges, quickstart guide, code examples, roadmap and contribution guide.

Paste in your AI

Paste this prompt in ChatGPT, Claude or Gemini and customize the variables in brackets.

Tu es un expert en documentation technique et open-source. Rédige un README complet et attrayant pour mon projet.

Nom du projet : [NOM_PROJET]
Description courte (une phrase) : [DESCRIPTION_COURTE]
Problème résolu : [PROBLEME_RESOLU]
Stack technique : [STACK_TECHNIQUE]
Cible : [CIBLE] (ex: développeurs Python, équipes DevOps)

Fonctionnalités principales :
[FONCTIONNALITES]

Structure le README avec :

Header : logo/nom, tagline, badges (CI, version, licence, stars)
Pourquoi ce projet : problème résolu vs alternatives existantes
Fonctionnalités : liste illustrée avec emojis si pertinent
Installation rapide : commande minimale pour démarrer
Guide de démarrage : exemple complet en 5 minutes
Documentation : lien ou section de référence
Exemples : 3 cas d'usage avec code
Roadmap : fonctionnalités prévues
Contribution : comment contribuer, code de conduite
Licence

Ton : professionnel mais accessible. Utilise Markdown GitHub-flavored.

Personalize this prompt with Léa

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

Why this prompt works

The Why this project vs alternatives section is crucial for convincing developers already accustomed to other tools. Badges immediately signal project maturity and reliability. The 5-minute quickstart is an important psychological standard for visitor conversion.

Use Cases

Publishing a new open-source projectImproving documentation of an existing projectPreparing a project for GitHub feature showcase

Expected Output

A complete Markdown README in 10 sections with header, badges, quickstart guide, code examples, roadmap and contribution guide.

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
Pour optimiser l’adoption, ajoutez un badge “Deploy to Vercel/Netlify” dans le header et un lien vers une démo live après le guide de démarrage. Cela crédibilise instantanément le projet auprès des utilisateurs pressés.