Crafting Effective READMEs

Generátor README řízený rozhovorem, se samostatnými šablonami pro OSS, osobní, interní a konfigurační repozitáře.

od softaworks · softaworks/agent-toolkit

Otestováno · Funguje ★ 9.2/10

Crafting Effective READMEs — Generátor README řízený rozhovorem, se samostatnými šablonami pro OSS, osobní, interní a konfigurační repozitáře.

Co umí

Před sepsáním README položí krátkou sadu otázek o publiku/úkolu (vytváření vs. přidávání vs. aktualizace vs. kontrola, a typ projektu) a pak použije jednu ze čtyř účelově navržených šablon místo obecné osnovy. Spouští se při psaní, přidávání do, aktualizaci nebo kontrole souboru README.

Testovací report

U nového OSS CLI nástroje neplnil jen text — nejdřív se zeptal na typ projektu a pak vyplnil sekce Contributing/Roadmap/Dev-setup z OSS šablony, které baseline, nevedený návrh úplně vynechal.

Testováno: 2026-07-13 · Claude Code 2.x (agent harness)

Instalace

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

Příkazy a ukázkové prompty

/crafting-effective-readmesGenerátor README řízený rozhovorem, se samostatnými šablonami pro OSS, osobní, interní a konfigurační repozitáře.

Skilly se spouštějí běžnými požadavky — žádné příkazy k zapamatování. Po instalaci ho aktivují prompty jako tyto (anglicky):

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

Kompletní testovací report (anglicky) →