README de projet quickstart

---
name: readme-projet-quickstart
description: "Génère un README.md clair, court et utile pour un projet logiciel. Structure standard : pitch 1 phrase, quickstart en 5 commandes max, stack, setup environnement, dev, tests, déploiement. À utiliser quand un dev (tech lead, freelance senior, équipe agence) initialise un nouveau repo, reprend un projet hérité sans doc, ou veut publier un repo open source GitHub / GitLab avec un README qui démarre vraiment un dev en 10 minutes."
metadata:
  iaskills_title: "README de projet quickstart"
  metier_slug: dev
  metiers:
    - Devs et tech leads
  secteur: "Tech & DSI"
  tier: free
  compatible:
    - claude-code
    - cowork
    - cursor
    - codex
  version: "1.0.0"
  author: "iaskills"
  editorial:
    pitch: "README qui démarre un dev en 10 min : pitch, quickstart 5 commandes, stack, setup env, dev, tests, deploy. Plus de README à 800 lignes que personne ne lit."
    long_description: "Génère un README.md court, structuré et utile pour un projet logiciel. Calibré pour les devs qui héritent d'un repo sans doc, initialisent un nouveau projet, ou veulent publier un repo open source qui ne décourage pas dès le scroll. Structure : titre + pitch 1 phrase, quickstart en 5 commandes max pour faire tourner le projet, stack technique, architecture si nécessaire (1 schéma), setup environnement (env vars + secrets, sans jamais hardcoder), commandes utiles dev (lint, format, build), tests, déploiement, contributing si open source. Pas de blabla marketing, pas de section vide, pas de badges décoratifs. Mentionne les bonnes pratiques sécurité (.env.example, secrets manager, pas de credentials commités). Adaptable selon le type de projet : SaaS Next.js, lib npm publiée, API Python, monorepo Turborepo."
    bullets:
      - "Quickstart 5 commandes max pour faire tourner"
      - "Setup env vars sans jamais hardcoder de secret"
      - "Sections obligatoires courtes, pas de remplissage"
      - "Adapté au type : SaaS, lib, API, monorepo"
      - "Mention sécurité .env.example par défaut"
    exemple_avant: "Vous reprenez un repo legacy sans README. 2h pour comprendre quel script lancer, 3 var env manquantes, le build casse 2 fois. Vous abandonnez et demandez à l'auteur original par Slack."
    exemple_apres: "README généré en 10 min. Le quickstart pnpm install, cp .env.example .env, pnpm db:migrate, pnpm dev marche du premier coup. Un nouveau dev clone et code en 15 min."
    recommended_metiers: []
    secteurs:
      - tech-dsi
      - startup-vc
    metiers_individuels:
      - dev-backend
      - dev-frontend
      - cto
      - devops
      - architecte-si
      - chef-de-projet-it
      - product-manager
      - founder-ceo
---

# README de projet quickstart

## Quand utiliser ce skill

Déclencher quand un dev (tech lead, staff engineer, freelance senior, dev backend ou frontend, DevOps) doit produire un README pour :

- Un **nouveau projet** initialisé qui n'a encore aucune doc
- Un **projet hérité** repris sans doc utilisable
- Un **repo open source** à publier sur GitHub ou GitLab pour la première fois
- Un **repo interne** d'équipe que tout nouveau dev doit pouvoir démarrer en 15 min

Ne pas utiliser pour :
- Une doc d'API détaillée (utiliser un OpenAPI / Swagger à la place)
- Une ADR (Architecture Decision Record)
- Un livre blanc technique de plus de 5 pages