Rédiger le README et la documentation d’installation d’un projet

La situation

La documentation est la première chose qui manque quand un projet change de mains. Un agent qui a accès au dépôt peut déduire les commandes réelles, les variables d’environnement et la structure, puis vérifier que les instructions fonctionnent en les exécutant.

Avant de commencer

Outil cité : Claude Code ; le prompt fonctionne aussi avec Codex et GitHub Copilot. Rassemblez les informations que le prompt vous demande. Retirez les données confidentielles qui ne sont pas utiles et vérifiez les conditions d’accès de votre outil. Les fonctionnalités et abonnements disponibles peuvent évoluer.

La méthode, en trois étapes.

1. 01

   Rassembler le contexte

   Réunissez les informations décrites dans le prompt.

2. 02

   Adapter le prompt

   Copiez le prompt ci-dessous, remplacez les éléments entre crochets, puis collez-le dans Claude Code, Codex ou GitHub Copilot.

3. 03

   Relire avant d’utiliser

   Relisez le résultat, corrigez-le si besoin et gardez la décision finale. Les points de vigilance sont détaillés plus bas.

Votre point de départ.

Remplacez les éléments entre crochets, puis adaptez la proposition à votre situation. Ce prompt est rédigé par la rédaction d’iadujour.

Lis ce dépôt et rédige un README.md en français :
- à quoi sert le projet (3 phrases)
- prérequis
- installation et lancement (commandes exactes)
- variables d’environnement (avec exemples fictifs)
- comment lancer les tests
- structure des dossiers
Exécute chaque commande d’installation dans un environnement propre et corrige le README si une étape échoue. Signale ce que tu n’as pas pu vérifier.

Ce qui mérite votre attention

Skills utiles

Des skills officielles qui portent sur la même tâche, rapprochées par la rédaction : elles ne font pas partie du cas décrit.

• Construire une application avec le SDK GitHub CopilotMicrosoft · Guide la création d’applications qui s’appuient sur GitHub Copilot via le Copilot SDK, pour des intégrations programmatiques en Node.js/TypeScript, Python, Go ou .NET : sessions, outils personnalisés, flux continu, hooks, serveurs MCP, fournisseurs BYOK, persistance, agents et skills, et schémas de déploiement.
• Créer un serveur MCP et des widgets pour Copilot ChatMicrosoft · Sert à construire des serveurs MCP pour Copilot Chat, avec le rendu de widgets (OpenAI Apps SDK ou MCP Apps SDK, n’importe quel langage), notamment des widgets React et Fluent UI et des outils qui renvoient structuredContent.
• Créer un agent déclaratif M365 Copilot ou TeamsMicrosoft · Permet de créer, assembler, déployer et localiser des agents déclaratifs pour M365 Copilot et Teams : échafaudage, modification des manifests, ajout de capacités ou de plugins.