Crafting Effective READMEs

Generador de README guiado por entrevista, con plantillas separadas para repos de código abierto, personales, internos y de configuración.

Por softaworks · softaworks/agent-toolkit

Probado · Funciona ★ 9.2/10

Crafting Effective READMEs — Generador de README guiado por entrevista, con plantillas separadas para repos de código abierto, personales, internos y de configuración.

Qué hace

Hace un breve conjunto de preguntas sobre audiencia/tarea (crear, añadir, actualizar o revisar, y tipo de proyecto) antes de redactar un README, y luego aplica una de cuatro plantillas específicas en lugar de un esquema genérico. Se activa al escribir, ampliar, actualizar o revisar un archivo README.

Informe de la prueba

Para una nueva herramienta CLI de código abierto no se limitó a escribir prosa -- primero preguntó por el tipo de proyecto y luego completó las secciones de Contribución/Hoja de ruta/Configuración de desarrollo de la plantilla OSS, que un borrador base sin guía omitió por completo.

Probado el: 2026-07-13 · Claude Code 2.x (agent harness)

Instalación

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

Comandos y prompts de ejemplo

  • /crafting-effective-readmesGenerador de README guiado por entrevista, con plantillas separadas para repos de código abierto, personales, internos y de configuración.

Los skills se activan con peticiones en lenguaje natural, sin comandos que memorizar. Tras instalarlo, prompts como estos lo activan (en inglés):

  • 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