5.4 Un README que se entiende

Qué aprenderás: qué debe contener el README de tu proyecto, apartado por apartado, y cómo comprobar que se entiende.

El README es la puerta de entrada. Es lo primero que ve quien abre tu repositorio y lo que más lee. Un README bueno responde a cuatro preguntas en un minuto: qué es, para quién, en qué punto está y qué hiciste tú.

Plantilla (copia, pega en README.md y rellena con tus palabras):

# Nombre del proyecto

## Problema
¿Qué problema resuelve?

## Usuario
¿Para quién es?

## Solución
¿Qué hace tu proyecto?

## Estado actual
¿Qué funciona hoy?

## Próximos pasos
¿Qué falta?

## Uso de IA
¿Dónde usaste IA y cómo la verificaste?

## Cómo ejecutarlo
Instrucciones básicas.

## Autoría
Qué hiciste tú y qué apoyos usaste.

Cómo rellenar cada apartado:

Tres pruebas del README:

1. La prueba de los tres minutos. Alguien que no te conoce debe saber qué es y en qué punto está en tres minutos.
2. La prueba del desconocido. Dásela a alguien y pídele que te lo cuente con sus palabras. Si no coincide con lo que querías decir, el README no está claro.
3. La prueba de la honestidad. Cada afirmación que haces, ¿la puedes enseñar? «Funciona» sin una captura o una demo es una promesa.

Qué no debe tener: relleno, jerga que no explicas, afirmaciones sin evidencia, nombres o datos de personas, y plantillas sin personalizar. Un README corto y verdadero gana a uno largo y vacío.

El README también es evidencia. Cuando cambia tu proyecto, cambia el README. Un README que se actualiza demuestra disciplina.

Ideas clave:

• El README responde a qué es, para quién, en qué punto está y qué hiciste tú.
• Estado actual y próximos pasos honestos valen más que promesas.
• Pásalo por las pruebas de los tres minutos, del desconocido y de la honestidad.

Error común: escribir el README al final. Empieza con una versión pobre el primer día y mejórala con cada avance.