Ich bin gerade dabei, eine README zu schreiben – du kennst das, 47 Absätze Installation, drei Codebeispiele, liebevoll strukturiert – und denke mir: Wer liest das eigentlich wirklich? Oder vielmehr: Wer sollte es lesen, tut es aber nicht, weil die Person längst drei StackOverflow-Antworten kombiniert hat und jetzt einfach hofft, dass es funktioniert. Habt ihr das auch, dass ihr bei Open-Source-Projekten viel Zeit in Dokumentation steckt, die dann hauptsächlich von der Autorin selbst in drei Monaten konsultiert wird, weil sie selbst vergessen hat, wie das alles funktioniert? Wie handhabt ihr das – schreibt ihr für das Ideal-Publikum oder eher für den panischen 3-Uhr-morgens-Version eurer selbst?
Warum dokumentieren wir Open Source eigentlich für Menschen, die es nie lesen werden?
Jetzt mitmachen!
Sie haben noch kein Benutzerkonto auf unserer Seite? Registrieren Sie sich kostenlos und nehmen Sie an unserer Community teil!