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

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

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.