Crafting Effective READMEs

Intervjudriven README-generator med separata mallar för OSS-, personliga, interna och konfigurationsrepon.

av softaworks · softaworks/agent-toolkit

Testad · Fungerar ★ 9.2/10

Crafting Effective READMEs — Intervjudriven README-generator med separata mallar för OSS-, personliga, interna och konfigurationsrepon.

Vad den gör

Ställer en kort uppsättning målgrupps-/uppgiftsfrågor (skapa vs lägga till vs uppdatera vs granska, samt projekttyp) innan en README utformas, och tillämpar sedan en av fyra ändamålsbyggda mallar istället för en generisk disposition. Triggas vid skrivande, tillägg till, uppdatering eller granskning av en README-fil.

Testrapport

För ett nytt OSS-CLI-verktyg skrev den inte bara löpande text — den ställde projekttypsfrågan först, och fyllde sedan i OSS-mallens Contributing/Roadmap/Dev-setup-sektioner som ett obistått baslinjeutkast helt hoppade över.

Testad: 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

Kommandon och exempelprompter

/crafting-effective-readmesIntervjudriven README-generator med separata mallar för OSS-, personliga, interna och konfigurationsrepon.

Skills triggas av vanliga förfrågningar — inga kommandon att memorera. Efter installationen aktiverar prompter som dessa skillen (på engelska):

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

Läs hela rapporten →