Crafting Effective READMEs

Interview-gestuurde README-generator met aparte templates voor OSS-, persoonlijke, interne en config-repo's.

Door softaworks · softaworks/agent-toolkit

Getest · Werkt ★ 9.2/10

Crafting Effective READMEs — Interview-gestuurde README-generator met aparte templates voor OSS-, persoonlijke, interne en config-repo's.

Wat het doet

Stelt een korte reeks vragen over doelgroep/taak (nieuw maken vs toevoegen vs bijwerken vs reviewen, en projecttype) voordat er een README wordt opgesteld, en past dan een van vier doelgerichte templates toe in plaats van een generieke outline. Triggert bij het schrijven, aanvullen, bijwerken of reviewen van een README-bestand.

Testrapport

Voor een nieuwe OSS-CLI-tool schreef het niet zomaar proza — het stelde eerst de vraag naar het projecttype, en vulde daarna de Contributing/Roadmap/Dev-setup-secties van de OSS-template in, die een baseline, ongestuurde tekst volledig oversloeg.

Getest op: 2026-07-13 · Claude Code 2.x (agent harness)

Installatie

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

Commando's en voorbeeldprompts

/crafting-effective-readmesInterview-gestuurde README-generator met aparte templates voor OSS-, persoonlijke, interne en config-repo's.

Skills reageren op gewone verzoeken — geen commando's om te onthouden. Na installatie activeren prompts zoals deze de skill (in het Engels):

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

Volledig rapport (Engels) →