Crafting Effective READMEs

Interviewgestützter README-Generator mit separaten Vorlagen für OSS-, persönliche, interne und Konfig-Repos.

von softaworks · softaworks/agent-toolkit

Getestet · Funktioniert ★ 9.2/10

Crafting Effective READMEs — Interviewgestützter README-Generator mit separaten Vorlagen für OSS-, persönliche, interne und Konfig-Repos.

Was es kann

Stellt vor dem Verfassen eines READMEs eine kurze Reihe von Zielgruppen-/Aufgabenfragen (Erstellen vs. Ergänzen vs. Aktualisieren vs. Review, sowie Projekttyp) und wendet dann eine von vier zweckgebundenen Vorlagen an statt einer generischen Gliederung. Triggert beim Schreiben, Ergänzen, Aktualisieren oder Review einer README-Datei.

Testbericht

Für ein neues OSS-CLI-Tool wurde nicht einfach drauflosgeschrieben — zuerst kam die Frage nach dem Projekttyp, dann wurden die Contributing-/Roadmap-/Dev-Setup-Abschnitte der OSS-Vorlage gefüllt, die ein unangeleiteter Baseline-Entwurf komplett ausließ.

Getestet am: 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

Befehle & Beispiel-Prompts

  • /crafting-effective-readmesInterviewgestützter README-Generator mit separaten Vorlagen für OSS-, persönliche, interne und Konfig-Repos.

Skills reagieren auf normale Anfragen — keine Slash-Befehle nötig. Nach der Installation aktivieren Prompts wie diese den Skill (auf Englisch):

  • 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