Crafting Effective READMEs

Interviewdrevet README-generator med separate skabeloner til OSS-, personlige, interne og konfigurationsrepoer.

Af softaworks · softaworks/agent-toolkit

Testet · Virker ★ 9.2/10

Crafting Effective READMEs — Interviewdrevet README-generator med separate skabeloner til OSS-, personlige, interne og konfigurationsrepoer.

Hvad det gør

Stiller et kort sæt spørgsmål om målgruppe/opgave (oprette vs. tilføje vs. opdatere vs. gennemgå, samt projekttype), før den udkaster en README, og anvender derefter en af fire formålsbyggede skabeloner i stedet for en generisk disposition. Udløses ved skrivning af, tilføjelse til, opdatering af eller gennemgang af en README-fil.

Testrapport

Til et nyt OSS CLI-værktøj skrev den ikke bare prosa — den stillede først spørgsmålet om projekttype og udfyldte derefter OSS-skabelonens afsnit om Contributing/Roadmap/Dev-setup, som et baseline-udkast uden vejledning helt sprang over.

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

Kommandoer og eksempelprompter

/crafting-effective-readmesInterviewdrevet README-generator med separate skabeloner til OSS-, personlige, interne og konfigurationsrepoer.

Skills udløses af almindelige forespørgsler — ingen kommandoer at huske. Efter installationen 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

Læs hele rapporten →