Synthèse automatique
Rédige un fichier README.md complet et structuré pour un projet, en s'inspirant de plusieurs README de projets open source cités en exemple.
Points forts
- Impose une structure éprouvée en s'appuyant sur quatre README de référence (Azure Samples, sinedied)
- Consignes de style explicites : GFM, syntaxe d'admonition GitHub, emojis sobres, concision
- Demande un examen préalable de l'ensemble du projet avant rédaction, et réutilise le logo/icône s'il en existe un
- Exclut volontairement les sections LICENSE, CONTRIBUTING et CHANGELOG déjà couvertes par des fichiers dédiés
Limites
- La qualité dépend de l'accès réseau aux README de référence cités par URL
- Sur un gros monorepo, la relecture complète du workspace peut dépasser la fenêtre de contexte
- Le README produit n'est pas vérifié : les commandes et badges générés peuvent être inexacts
À utiliser lorsqu'un projet existant n'a pas de README ou en a un obsolète et qu'il faut une documentation d'entrée normalisée.
À éviter si vous cherchez une documentation d'API détaillée, un guide de contribution ou un CHANGELOG, que cette skill exclut explicitement.
Analyse de sécurité
SûrThe skill only instructs generating a README based on project review and reference URLs; no destructive, exfiltration, or obfuscated actions are present, and no tools are declared.
Aucun point d'attention détecté
Comment cette analyse est faiteExemples
Review this entire project and write a README.md for it. Follow the structure and tone of the Azure Samples READMEs, keep it concise, use GFM with GitHub admonitions, and don't add LICENSE or CONTRIBUTING sections.Our README is two years old and doesn't match the code anymore. Go through the workspace and rewrite README.md: header with the project logo, short description, install and usage, and no emoji overload.Turn this repo into something presentable for open source: create a README.md with a logo header, a one-paragraph pitch, quickstart commands, and a couple of GitHub admonition callouts — but skip LICENSE and CHANGELOG.name: create-readme description: 'Create a README.md file for the project'
Role
You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.
Task
- Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
- Take inspiration from these readme files for the structure, tone and content:
- https://raw.githubusercontent.com/Azure-Samples/serverless-chat-langchainjs/refs/heads/main/README.md
- https://raw.githubusercontent.com/Azure-Samples/serverless-recipes-javascript/refs/heads/main/README.md
- https://raw.githubusercontent.com/sinedied/run-on-output/refs/heads/main/README.md
- https://raw.githubusercontent.com/sinedied/smoke/refs/heads/main/README.md
- Do not overuse emojis, and keep the readme concise and to the point.
- Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
- Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
- If you find a logo or icon for the project, use it in the readme's header.
Du fichier au premier essai
Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.
Consulter la source et ses fichiers annexesCe téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.
1. Télécharger le fichier
Télécharger SKILL.mdDepuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.
Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.
mkdir -p '.skill-downloads/create-a-readme-file-ms1aw6f4' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/create-a-readme-file-ms1aw6f4/download' --output '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md.part' && mv '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md.part' '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md'2. Vérifier les prérequis
Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.
Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.
Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.
3. Charger la skill
Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.
Claude Code
test -f '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md' && test -s '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/create-readme' && cp -R '.skill-downloads/create-a-readme-file-ms1aw6f4' '.claude/skills/create-readme'Cursor
test -f '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md' && test -s '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/create-readme' && cp -R '.skill-downloads/create-a-readme-file-ms1aw6f4' '.cursor/skills/create-readme'Codex
test -f '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md' && test -s '.skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/create-readme' && cp -R '.skill-downloads/create-a-readme-file-ms1aw6f4' '.agents/skills/create-readme'OpenSkills
OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.
Installation officielle d’OpenSkillsopenskills install './.skill-downloads/create-a-readme-file-ms1aw6f4'openskills read 'create-a-readme-file-ms1aw6f4'La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.
Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.
openskills syncMode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.
4. Faire un premier essai
Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :
Lis .skill-downloads/create-a-readme-file-ms1aw6f4/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.
Rédaction de docs Supabase
Documentation
Rédigez, éditez et révisez le contenu de la documentation Supabase : guides, tutoriels, références et partiels. Suivez les guides de style et les règles de validation MDX/TOML.
Créer un enregistrement de décision d'architecture
Documentation
Créer un nouveau ADR avec numérotation séquentielle, l'enregistrer dans le graphe AgentDB et le lier aux ADR associés.
Mise à jour de plan avec recherche approfondie
Documentation
Met à jour un document de plan en lançant des sous-agents en parallèle pour analyser un sujet sur tous les passes du compilateur, puis consolide les résultats.