Sensey
Vakmanschap19 mrt. 20263 min leestijd

Ode aan de README

Het kleinste document, het grootste geschenk.

Written by Sensey Team

Stel je voor dat een vreemde om drie uur 's nachts bij je project aanklopt. Ze zijn gekomen om iets urgents te repareren. Ze zullen jou niet ontmoeten. Ze zullen alleen ontmoeten wat jij hebt achtergelaten.

Strofe I

De vreemde aan de deur

De README is de lamp bij de deur. Steek hem goed aan.

Strofe II

Wat het altijd moet zeggen

Wat is dit. Waarom bestaat het. Hoe draai ik het lokaal in minder dan vijf minuten. Waar leeft het in productie. Wie maak ik wakker als het breekt.

Als je README die vijf vragen beantwoordt, heb je de vreemde aan de deur geëerd.

End of scroll

Sensey Team

Sensey · Vakmanschap