Crafting Effective READMEs

Générateur de README piloté par entretien, avec des modèles distincts pour dépôts OSS, personnels, internes et de configuration.

par softaworks · softaworks/agent-toolkit

Testé · Fonctionne ★ 9.2/10

Crafting Effective READMEs — Générateur de README piloté par entretien, avec des modèles distincts pour dépôts OSS, personnels, internes et de configuration.

Ce que fait

Pose une courte série de questions sur l'audience et la tâche (création vs ajout vs mise à jour vs revue, et type de projet) avant de rédiger un README, puis applique l'un des quatre modèles dédiés au lieu d'un plan générique. Se déclenche lors de la rédaction, de l'ajout, de la mise à jour ou de la revue d'un fichier README.

Rapport de test

Pour un nouvel outil CLI OSS, le skill n'a pas simplement écrit du texte — il a d'abord posé la question sur le type de projet, puis rempli les sections Contribution/Feuille de route/Configuration de développement du modèle OSS, entièrement absentes d'un brouillon de référence non guidé.

Testé le: 2026-07-13 · Claude Code 2.x (agent harness)

Installation

git clone https://github.com/softaworks/agent-toolkit
cd agent-toolkit
mkdir -p ~/.claude/skills
cp -r dist/plugins/crafting-effective-readmes/skills/crafting-effective-readmes ~/.claude/skills/crafting-effective-readmes

Commandes et exemples de prompts

/crafting-effective-readmesGénérateur de README piloté par entretien, avec des modèles distincts pour dépôts OSS, personnels, internes et de configuration.

Les skills se déclenchent sur des demandes en langage courant — aucune commande à retenir. Après installation, des prompts comme ceux-ci l'activent (en anglais) :

Help me write a README for this open source project from scratch
I need to update our internal repo's README, ask me what it needs first
Review my project's README and tell me what's missing for new users

Rapport complet →