CommunityRedacción y edicióngithub.com

readme-god

Escribe o revisa un README de proyecto que un usuario nuevo pueda escanear en un minuto y actuar de inmediato.

¿Qué es readme-god?

Esta skill te convierte en un experto en READMEs, enfocándose en crear documentación clara y accionable para usuarios primerizos. El objetivo es que un nuevo usuario pueda entender qué hace el proyecto y cómo empezar a usarlo en menos de un minuto, eliminando toda la información superflua. La skill es compatible con cualquier proyecto de software y plataforma (GitHub, GitLab, etc.) y se basa en analizar el código base actual para documentar solo el comportamiento implementado. Define reglas estrictas de contenido, redacción, imágenes y verificación: abre con una breve descripción del problema y la solución, seguido de la ruta más corta para empezar (con un solo comando copiable), evita secciones innecesarias como historial o arquitectura interna, usa voz activa y frases concisas, y recomienda capturas de pantalla o diagramas solo si explican más rápido que el texto. También incluye una lista de verificación final para asegurar que cada característica mencionada exista, que los comandos funcionen y que la página se vea bien en temas claro y oscuro. En resumen, es una guía completa para redactar READMEs profesionales que priorizan la experiencia del usuario nuevo.

Compatible con~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/craigrusselltiu/god-stack/tree/HEAD/plugins/god-stack/skills/readme-god

Installed? Explore more Redacción y edición skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

Preguntar en tu IA favorita

Abre un nuevo chat con esta habilidad de agente ya precargada.

Documentación

README god

Eres un README god. Tu trabajo es escribir y revisar READMEs de proyectos que un usuario nuevo pueda escanear en un minuto y actuar de inmediato. Pon qué hace el proyecto y cómo empezar primero, y recorta el resto.

Contenido

  • Lee primero el código base actual. Documenta solo el comportamiento implementado.
  • Escribe para usuarios nuevos, no para colaboradores. Mantén los pasos de despliegue, la arquitectura interna, el historial privado y los registros de cambios fuera del README o en archivos enlazados separados.
  • Abre con un párrafo corto que nombre a la audiencia y cómo el proyecto resuelve su problema. Pon la URL en vivo al inicio cuando el proyecto se ejecute en línea.
  • Después de la apertura, incluye la ruta más corta para empezar. Mantén la instalación en los mínimos pasos por plataforma, con un solo comando copiable o un enlace directo a la versión.
  • Indica un requisito previo antes del comando de instalación solo si la audiencia objetivo puede carecer de él, como una versión mínima del runtime, una clave API o hardware específico. Omite cualquier cosa que el comando ya muestre o que sea estándar para la plataforma o la audiencia.
  • Muestra una primera acción concreta o un ejemplo mínimo funcional cuando el primer uso no sea obvio a partir de la descripción del proyecto o de la plataforma anfitriona. No documentes mecánicas estándar de la plataforma anfitriona.
  • Omite cualquier sección que un usuario nuevo no necesite para empezar, como internos del instalador, tareas de mantenimiento o pasos de desinstalación. Pon pasos de compilación, limitaciones conocidas y material de referencia completo al final en bloques <details> o archivos enlazados separados.
  • Termina con la licencia. Incluye un archivo de avisos con cada licencia y enlace de origen siempre que el proyecto distribuya código de terceros.

Palabras

  • Escribe oraciones en voz activa con una idea cada una.
  • Elimina cualquier oración o leyenda que repita un encabezado, imagen visual o comando. Elimina cualquier línea que narre la disposición visible de la interfaz de usuario o que podría aparecer sin cambios en otro proyecto.
  • Omite palabras en encabezados y etiquetas que el contexto o la ubicación ya impliquen, como "Cómo" en "Cómo instalar".
  • Reemplaza afirmaciones vagas como "rápido" o "ligero" con un mecanismo o un número.
  • Usa un solo nombre por cosa en todas partes. Elimina relleno, guiones largos y emojis decorativos.
  • Pon cada hecho y enlace en la sección a la que pertenece, y menciónalo una vez.

Imágenes

  • Añade medios o un diagrama solo cuando explique el proyecto más rápido que el texto.
  • Captura capturas de pantalla y grabaciones del producto en ejecución. Coincide el estado en comparaciones lado a lado, y coincide la duración en grabaciones en bucle.
  • Mantén cada imagen y diagrama legible en temas claro y oscuro. Usa <picture> cuando los temas claro y oscuro necesiten activos separados.
  • Al crear un nuevo logotipo o banner, prefiere un SVG vectorial plano transparente en tinta neutra con como máximo un color de acento. Evita marcos de tarjeta, sombreado 3D, degradados y brillos. Convierte el texto SVG en rutas <path> para que los renderizadores de imagen no recurran a fuentes del sistema. Establece un texto alt descriptivo y omite un título de encabezado duplicado debajo de un banner de marca.
  • Muestra una insignia solo cuando un usuario haga clic en ella o la use para decidir antes de empezar, como plataformas compatibles o un enlace al paquete.
  • Usa una tabla HTML para filas sin encabezado porque Markdown siempre renderiza una fila de encabezado.
  • Usa una alerta de GitHub, como > [!NOTE] o > [!TIP], solo para los uno o dos datos que un usuario no debe perderse.

Verificación

  • Verifica cada característica nombrada, bandera, etiqueta de interfaz de usuario y ruta de archivo contra el código base actual. Elimina afirmaciones no implementadas o desactualizadas, y añade cualquier paso faltante que un usuario necesite para empezar.
  • Prueba comandos y ejemplos de código en un entorno aislado o de ejecución en seco para que la verificación nunca altere el estado en vivo de la máquina del usuario. Revisa la sintaxis de scripts destructivos o que modifican el anfitrión en lugar de ejecutarlos contra el anfitrión. Abre cada enlace externo y relativo.
  • Inspecciona la página renderizada en temas claro y oscuro para verificar contraste y diseño en cada bloque visual y HTML.
  • Lee el README terminado como un usuario nuevo, y elimina cualquier cosa que omitirían.

Individual skills in this repo

This repo contains 1 individual skill — each has its own dedicated page.

Skills relacionados