Sensey
Handwerk19. Mär. 20263 Min. Lesezeit

Eine Ode an die README

Das kleinste Dokument, das größte Geschenk.

Written by Sensey Team

Stell dir vor, ein Fremder kommt um drei Uhr morgens an dein Projekt. Er ist gekommen, um etwas Dringendes zu reparieren. Er wird dich nicht treffen. Er wird nur dem begegnen, was du hinterlassen hast.

Strophe I

Der Fremde an der Tür

Die README ist die Lampe an der Tür. Zünde sie gut an.

Strophe II

Was sie immer sagen sollte

Was ist das. Warum existiert es. Wie bringe ich es lokal in unter fünf Minuten zum Laufen. Wo lebt es in Produktion. Wen wecke ich, wenn es bricht.

Wenn deine README diese fünf Fragen beantwortet, hast du den Fremden an der Tür geehrt.

End of scroll

Sensey Team

Sensey · Handwerk