Fundstück: The Art of Readme

von tobonaut

Der Github User noffle hat sich mit seinem Repository art-of-readme ganz der Kunst des Readme-Schreibens verschrieben.

Ein kurzer Ausschnitt des Pamphlets:

This is an article about READMEs. About what they do, why they are an absolute necessity, and how to craft them well.

This is written for module creators, for as a builder of modules, your job is to create something that will last. This is an inherent motivation, even if the author has no intent of sharing their work. Once 6 months pass, a module without documentation begins to look new and unfamiliar.

Egal ob man es nun so extravagant sieht oder doch einen etwas legeren Umgang mit Readme-Dateien pflegt. Sie gehören meiner Meinung nach zwingend zu jedem Projekt – egal ob quelloffen, privat, als Lonerider oder als Teamprojekt.

Advertisements