Crafting Effective READMEs

Intervjudrevet README-generator med egne maler for OSS-, personlige, interne og config-repoer.

av softaworks · softaworks/agent-toolkit

Bestått ★ 9.2/10

Crafting Effective READMEs — Intervjudrevet README-generator med egne maler for OSS-, personlige, interne og config-repoer.

Hva den gjør

Stiller et kort sett med spørsmål om målgruppe/oppgave (opprette vs. legge til vs. oppdatere vs. gjennomgå, og prosjekttype) før den utkaster en README, og bruker deretter én av fire formålsbygde maler i stedet for en generisk disposisjon. Trigges ved skriving, tillegg, oppdatering eller gjennomgang av en README-fil.

Testrapport

For et nytt OSS-CLI-verktøy skrev det ikke bare løpende tekst — det stilte prosjekttype-spørsmålet først, og fylte deretter ut OSS-malens Contributing/Roadmap/Dev-setup-seksjoner som et baseline-utkast uten veiledning hoppet helt over.

Testet på: 2026-07-13 · Claude Code 2.x (agent harness)

Installer

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

Kommandoer og eksempelprompter

/crafting-effective-readmesIntervjudrevet README-generator med egne maler for OSS-, personlige, interne og config-repoer.

Skills utløses av vanlige forespørsler — ingen kommandoer å huske. Etter installasjonen aktiverer prompter som disse skillen (på engelsk):

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

Full rapport →