Crafting Effective READMEs

Generatore di README guidato da un'intervista, con template separati per repo OSS, personali, interni e di configurazione.

di softaworks · softaworks/agent-toolkit

Promosso ★ 9.2/10

Crafting Effective READMEs — Generatore di README guidato da un'intervista, con template separati per repo OSS, personali, interni e di configurazione.

Cosa fa

Fa una breve serie di domande su pubblico/compito (creare vs aggiungere vs aggiornare vs revisionare, e tipo di progetto) prima di scrivere un README, poi applica uno di quattro template mirati invece di uno schema generico. Si attiva quando si scrive, si aggiunge, si aggiorna o si revisiona un file README.

Rapporto di test

Per un nuovo strumento CLI OSS non si è limitato a scrivere prosa — ha prima chiesto il tipo di progetto, poi ha compilato le sezioni Contributing/Roadmap/Dev-setup del template OSS che una bozza di base non guidata aveva saltato del tutto.

Testato il: 2026-07-13 · Claude Code 2.x (agent harness)

Installazione

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

Comandi e prompt di esempio

/crafting-effective-readmesGeneratore di README guidato da un'intervista, con template separati per repo OSS, personali, interni e di configurazione.

Gli skill si attivano con richieste in linguaggio naturale, senza comandi da ricordare. Dopo l'installazione, prompt come questi lo attivano (in inglese):

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

Rapporto completo →