Sensey
Oficio19 mar 20263 min de lectura

Una oda al README

El documento más pequeño, el regalo más grande.

Written by Sensey Team

Imagina que un desconocido llega a tu proyecto a las tres de la mañana. Ha venido a arreglar algo urgente. No te encontrará a ti. Solo encontrará lo que dejaste atrás.

Estrofa I

El desconocido en la puerta

El README es la lámpara junto a la puerta. Enciéndela bien.

Estrofa II

Lo que siempre debería decir

Qué es esto. Por qué existe. Cómo lo ejecuto en local en menos de cinco minutos. Dónde vive en producción. A quién despierto si se rompe.

Si tu README responde a esas cinco preguntas, has honrado al desconocido en la puerta.

End of scroll

Sensey Team

Sensey · Oficio