Was sind README-Dateien und wie verwendet man sie richtig?

Wer mit digitalen Projekten arbeitet, stößt früher oder später auf eine Datei mit dem Namen READMEAuch wenn es wie ein einfaches Textdokument aussieht, ist es viel wichtiger, als es scheint: Es ist das Anschreiben für Ihr Projekt, der erste Anlaufpunkt für alle, die wissen möchten, was Sie gemacht haben, wie man es benutzt und ob es sich lohnt, sich damit zu beschäftigen.

In der Welt der Softwareentwicklung, der Datenwissenschaft oder auch in der akademischen Arbeit und in kollaborativen Projekten, ein README gut geschrieben Es spart Zeit, beugt Fehlern vor und erleichtert es anderen (oder auch Ihnen selbst in ein paar Monaten), den Zweck des Projekts schnell zu verstehen. Sehen wir uns genauer an, was README-Dateien sind, wozu sie dienen, was sie enthalten sollten und wie man sie optimal nutzt.

Was genau ist eine README-Datei?

Eine README-Datei ist eine Textdokument, das ein digitales Projekt begleitet Das Hauptziel ist es, klar zu erklären, was das Projekt beinhaltet, wozu es dient und wie man es benutzt. Wörtlich übersetzt hieße es so viel wie „Lies mich“, und genau das ist seine Funktion: Es soll das Erste sein, was jemand liest, wenn er ein Repository, einen Datenordner oder ein Softwarepaket öffnet.

Dieser Dateityp kann in verschiedenen Formaten gespeichert werden. Textformate: vom Klassiker readme.txt (Klartext) bis zu readme.doc, readme.1st oder weniger gebräuchliche Erweiterungen wie . MeDas spezifische Format wird üblicherweise angepasst an Betriebssystem und das Programm, mit dem es angezeigt wirdso dass jeder Benutzer die Datei ohne Komplikationen öffnen und lesen kann.

Heutzutage ist insbesondere in Softwareprojekten und Code-Repositories das gebräuchlichste Format: README.mdDie Dateiendung .md zeigt an, dass die Datei in diesem Format geschrieben wurde. MarkdownHTML ist eine sehr einfache Auszeichnungssprache, mit der man Text mithilfe weniger Formatierungssymbole in HTML umwandeln kann. Dadurch wird die Formatierung des Inhalts vereinfacht. Sowohl im Rohformat als auch in der gerenderten Form auf einem Webportal leicht lesbar.Darüber hinaus ermöglicht es die problemlose Darstellung von Titeln, Listen, Links, Tabellen, Bildern und mehr.

Eine gut strukturierte README-Datei bietet dem Benutzer oder Mitwirkenden eine vollständige und verständliche Zusammenfassung des ProjektsEs soll kein umfassendes Dokument sein, sondern ein praktischer Leitfaden: Was das Projekt leistet, warum es nützlich ist, wie man es nutzt und wo man bei Bedarf weitere Informationen findet.

Im Bereich der Daten, beispielsweise in Datensatz-Repositories, ist es sehr üblich, dass die README-Datei (manchmal im .uk-Format) folgendes Format hat: readme.txt) sammeln Allgemeine Informationen, Autorenschaft, Schlagwörter, geografischer und zeitlicher Umfang, Nutzungslizenz und Methodik verwendet, um die Daten zu generieren oder zu sammeln, sowie die Empfohlene Software für die Arbeit mit ihnen.

Eine kurze Geschichte und Standardverwendung von README-Dateien

Obwohl wir sie heute hauptsächlich mit Plattformen wie GitHub in Verbindung bringen, stammt die Praxis, eine README-Datei in Softwarepakete einzufügen, aus der Zeit, als wir sie vor 1960 in den USA aufnahmen. vor JahrzehntenEs gibt dokumentierte Beispiele, die bis ins Jahr zurückreichen. Mitte 70als Programme bereits mit einem kleinen Dokument verbreitet wurden, das ihren Inhalt und ihre Verwendung erläuterte.

Im Laufe der Zeit etablierte sich diese Praxis so sehr, dass sie in der GNU-Codierungsstandards (GNU-Codierungsstandards) Die README-Datei wird als eine AnforderungDiese Standards hatten großen Einfluss auf das Ökosystem freier Software und trugen dazu bei, dass die README-Datei in fast jedem ernstzunehmenden Softwarepaket obligatorisch wurde.

Als das Web zum Standardplattform für den SoftwarevertriebViele Projekte begannen damit, einen Teil der Informationen, die sich zuvor in der README-Datei befanden (Handbücher, Lizenz, Neuigkeiten usw.), auf Websites, Wikis oder ähnliches auszulagern. Quellcode-Tarball-PaketDennoch verschwand die README-Datei nie: In vielen Fällen blieb sie erhalten als Lokale Zusammenfassungobwohl sie im Vergleich zur Online-Dokumentation manchmal etwas unvollständig blieb.

Die Popularität von Plattformen wie GitHub Die Bemühungen etablierter Open-Source-Communities haben README-Dateien wieder in den Vordergrund gerückt. Auf GitHub beispielsweise wird eine README-Datei automatisch hinzugefügt, wenn ein Repository im Stammverzeichnis eine solche Datei enthält. Es wird automatisch in HTML konvertiert und auf der Startseite angezeigt. Es ist das erste, was man beim Betreten des Projekts sieht.

Des Weiteren wird der Begriff einer „Readme-Datei“ manchmal in einer generisch Als README bezeichnet man jedes kurze Dokument, das den Inhalt eines Ordners oder Projekts erläutert, auch wenn die Datei nicht explizit README heißt. Viele Open-Source-Softwareprojekte liefern neben der README-Datei einen Standardsatz an Dateien mit jeweils einer klar definierten Funktion aus.

Typische Dateien, die einer README-Datei beiliegen

In Projekten, die Standards wie beispielsweise Gnits-Standards oder solche, die mit Werkzeugen wie z. B. GNU AutotoolsNeben der Haupt-README-Datei finden sich häufig weitere Textdateien, die die Projektinformationen ergänzen. Zu den typischsten gehören:

• READMEAllgemeine Informationen über das Projekt, seinen Zweck und seine Gesamtvision.
• AUTOREN: Liste der Hauptautoren bzw. Mitarbeiter.
• DANKDanksagungen an Personen oder Institutionen, die geholfen haben.
• ÄNDERUNGSPROTOKOLL: detailliertes Änderungsprotokoll, primär für Entwickler konzipiert.
• NEWS: ein prägnanteres und verständlicheres Änderungsprotokoll für Endbenutzer.
• INSTALLIEREN: spezifische Installationsanweisungen und technische Anforderungen.
• KOPIEREN / LIZENZ: Text der Softwarelizenz zur Nutzung und Verbreitung.
• FehlerBekannte Fehler und Möglichkeiten, diese korrekt zu melden.
• FAQHäufig gestellte Fragen und ihre Antworten.
• ALLESListe der anstehenden Aufgaben und geplanten zukünftigen Verbesserungen.

Alle diese Dokumente bilden zusammen mit der README-Datei Folgendes: das Grundgerüst der Basisdokumentation von vielen Paketen. In einigen Fällen werden einige dieser Informationen sowohl im Repository als auch auf der Projektwebsite dupliziert, um den Zugriff über verschiedene Kanäle zu erleichtern.

Die Rolle der README-Datei auf GitHub und ähnlichen Plattformen

Auf GitHub spielt die README-Datei eine besonders wichtige Rolle. Zunächst einmal ist sie üblicherweise das Erste, was jeder sieht wer besucht Ihr RepositoryWenn die Datei gut gestaltet ist, wird in wenigen Sekunden deutlich, worum es in dem Projekt geht, warum es von Interesse sein könnte, wie man es in Betrieb nimmt und wer dahintersteckt.

GitHub erkennt die README-Datei automatisch, wenn sie in bestimmten Repository-Verzeichnissen abgelegt wird. Wenn Sie sie beispielsweise in den Ordner legen .github, In der Stammverzeichnis oder im Ordner docsDie Plattform erkennt es und zeigt prominent an für Besucher. Wenn mehrere README-Dateien vorhanden sind, folgt GitHub einem bestimmten Schema. Reihenfolge der Priorität: erste Suche in .githubdann an der Wurzel und schließlich bei docs.

Wenn Sie außerdem ein öffentliches Repository erstellen, dessen Name exakt mit Ihrem übereinstimmt Benutzername Und wenn Sie eine README-Datei im Stammverzeichnis hinzufügen, wird diese Datei automatisch zu Ihrer README-Datei. Profil-READMEEs wird auf Ihrer Benutzerseite angezeigt und ermöglicht Ihnen, mit GitHub Flavored Markdown einen benutzerdefinierten Präsentationsbereich zu erstellen.

Wenn eine README-Datei (oder eine beliebige .md-Datei) auf GitHub angezeigt wird, generiert die Plattform automatisch eine Inhaltsverzeichnis Anhand der Dokumenttitel. Sie können dieses Inhaltsverzeichnis durch Klicken auf das Symbol „Gliederung“ aufrufen, was die Navigation in langen README-Dateien mit mehreren Abschnitten deutlich erleichtert.

GitHub erlaubt auch Direkter Link zu bestimmten AbschnittenJede Überschrift generiert automatisch einen Link; wenn Sie mit der Maus über den Titel fahren, wird das Link-Symbol angezeigt. So können Sie URLs teilen, die direkt zu dem Abschnitt der README-Datei führen, den Sie hervorheben möchten (z. B. den Installations- oder den Beitragsabschnitt).

Ein wichtiger praktischer Hinweis: Aus Performancegründen sollte Ihre README-Datei die angegebene Länge überschreiten. 500 KiB von Größe, GitHub wird den Inhalt kürzen Ab diesem Zeitpunkt in der gerenderten Ansicht. Daher empfiehlt es sich, die README-Datei für wesentliche Informationen zu reservieren und längere Anleitungen oder Handbücher in Wikis oder separate Dokumentationen auszulagern.

Format und Links in einer README-Datei

Um die README-Datei wartungsfreundlich zu gestalten und sowohl auf GitHub als auch auf lokalen Klonen eine einwandfreie Funktion zu gewährleisten, wird die Verwendung von … empfohlen. relative Links und Bildpfade relativ zu der Datei, in der sie sich befinden. Wenn Sie beispielsweise eine README-Datei im Stammverzeichnis und ein Dokument haben docs/CONTRIBUTING.mdDer Link in der README-Datei würde etwa so aussehen: (docs/CONTRIBUTING.md).

Diese Art von relativem Link bedeutet, dass beim Wechseln von Branches oder beim Klonen des Repositorys, Die Routen funktionieren weiterhin einwandfrei. ohne dass sie geändert werden müssen. GitHub transformiert diese Pfade intern, sodass sie basierend auf dem angezeigten Branch auf die korrekte Dateiversion verweisen. Pfade, die mit beginnen /die relativ zum Repository-Root interpretiert werden, sowie gängige Operatoren wie ./ o ../.

Es ist wichtig, dass die Link Text Der Link sollte in einer einzigen Zeile stehen, da eine Aufteilung auf mehrere Zeilen zu Fehlfunktionen führen kann. Vermeiden Sie außerdem absolute Links zu internen Repository-Dateien, da diese ungültig werden können, wenn sich die Basis-URL ändert oder ein Fork erstellt wird.

Bezüglich des Umfangs des Dokuments ist zu beachten, dass die README-Datei nur Folgendes enthalten sollte: die wichtigsten Informationen für den Einstieg und die Mitwirkung für das Projekt. Für eine umfassende Dokumentation (Benutzerhandbücher, vollständige API-Leitfäden usw.) ist es übersichtlicher, ein Wiki oder ein separates Dokumentationssystem, das von der README-Datei selbst verlinkt wird.

Was ist der eigentliche Zweck einer README-Datei?

Über die Theorie hinaus fungiert die README-Datei in der Praxis als erste Orientierungshilfe und BezugspunktSie soll keine umfangreiche formale Dokumentation ersetzen, sondern vielmehr eine geordnete und praktische Erläuterung der wichtigsten Aspekte des Projekts bieten.

Zu den häufigsten Anwendungsgebieten gehören: das Ziel erläutern des Projekts, beschreiben Sie, welche Daten oder Dateien es umfasst, geben Sie an, wie man es benutzt, und spezifizieren Sie wichtige technische Anforderungen und Fehler durch unsachgemäße Verwendung vermeidenWenn mehrere Benutzer am selben Code oder denselben Daten arbeiten, erspart eine übersichtliche README-Datei endlose, sich wiederholende Fragen.

In gemeinsamen Projekten, insbesondere in großen Teams oder Open-Source-Communities, ist die README-Datei fast schon ein Muss. Komponente der KommunikationsinfrastrukturEs dient dazu, Erwartungen aufeinander abzustimmen, den Reifegrad des Projekts anzuzeigen, zu definieren, wie man sich einbringen kann, und zu verdeutlichen, welche Unterstützung angeboten wird (falls überhaupt).

Selbst bei persönlichen Projekten, selbst wenn nur Sie daran arbeiten, dient eine gut geschriebene README-Datei als LangzeitgedächtnisMit der Zeit geraten Entscheidungen, Abhängigkeiten oder Installationsschritte leicht in Vergessenheit; eine Dokumentation erspart Ihnen die Notwendigkeit, Ihr eigenes Projekt Monate später wiederzuentdecken.

Daher ist die README-Datei nicht nur eine Formalität, sondern ein praktisches Werkzeug zur Verbesserung der Organisation, Kommunikation und Wartbarkeit von jeder Art von digitalem Projekt.

Wann ist es angebracht, eine README-Datei zu erstellen?

Die kurze Antwort lautet: Es ist eine gute Idee, eine README-Datei zu erstellen. immer dann, wenn ein Projekt genutzt, überprüft oder gewartet werden soll. von jemand anderem als dem ursprünglichen Schöpfer… und das schließt auch dein zukünftiges Ich ein. Es muss kein riesiges Open-Source-Repository sein: Es muss lediglich eine gewisse Komplexität aufweisen oder der Inhalt Fragen aufwerfen.

Einige Beispiele, bei denen eine README-Datei besonders nützlich ist, sind die Web- oder ProgrammierprojekteDort empfiehlt es sich, Anforderungen, Entwicklungsprozesse, Startbefehle und die Laufzeitumgebung zu erläutern. Es ist auch sehr interessant in Ordner mit wichtigen Datenum zu verdeutlichen, was diese Daten darstellen, woher sie stammen und welche möglichen Einschränkungen bestehen.

Weitere typische Kontexte sind die Websites, die auf einem Hosting gehostet werdendie oft eine README-Datei mit Bereitstellungsanweisungen oder die akademische und technische ArbeitenIn der README-Datei können Skripte, Experimente, Versionen der verwendeten Tools oder Anleitungen zur Reproduktion der Ergebnisse beschrieben werden.

En GemeinschaftsprojekteOb intern oder öffentlich, die README-Datei ist nahezu unerlässlich. Sie erleichtert neuen Projektmitgliedern den Einstieg und dient als gemeinsame Referenz, um einheitliche Nutzungs- und Beitragsstandards für alle Beteiligten zu gewährleisten.

Welche Informationen sollte eine gute README-Datei enthalten?

Eine effektive README-Datei muss nicht lang sein, aber sie muss … gut organisiert und sehr übersichtlichEs gibt einige grundlegende Informationen, die fast immer enthalten sein sollten, und weitere optionale Inhalte, die je nach Art des Projekts einen großen Mehrwert bieten.

Die meisten gut dokumentierten Repositories und Pakete enthalten zumindest die Projektnameeiner kurze Beschreibung des Ziels, eine Zusammenfassung des Inhalts des Repositorys, die Anleitung zur Verwendung oder Installation und die wesentlichen Voraussetzungen (Abhängigkeiten, minimale Sprachversion, Betriebssystem usw.).

Es wird außerdem dringend empfohlen, Folgendes hinzuzufügen: Kontakt- oder SupportmethodeSelbst wenn es sich nur um eine E-Mail oder einen Link zum Abschnitt „Probleme“ des Repositorys handelt, hilft dies jedem, der auf Probleme stößt, zu erkennen, wo und wie er diese melden kann, anstatt ihn ratlos und unsicher zurückzulassen, an wen er sich wenden soll.

Zusätzlich zu den Grundlagen ist es oft hilfreich, Informationen über Folgendes anzugeben: Erstellungsdatum oder Version die aktuelle Liste der Autoren oder Verantwortlichen, die Nutzungslizenz und alle relevanten Hinweise zur Verwendung der Daten oder des Codes (z. B. ob es sich um eine experimentelle Version handelt oder ob diese nicht für den Produktiveinsatz geeignet ist).

Die Reihenfolge beeinflusst auch die Lesbarkeit: Die wichtigsten Informationen (was das Projekt ist, wozu es dient, wie es verwendet wird) sollten an erster Stelle stehen. am Anfang des DokumentsSekundäre Details, ausführliche Credits oder historische Anmerkungen werden später aufgeführt. So kann sich auch jemand, der nur über die Seite stöbert, auf einen Blick einen klaren Überblick verschaffen.

Typischer Inhalt einer README-Datei in Software

In Softwareprojekten gehen README-Dateien oft noch einen Schritt weiter und enthalten mehrere zusätzliche thematische Abschnitte. In vielen Fällen fasst die Datei kurz zusammen: InstallationsanweisungenInstallationsanleitung, grundlegende Gebrauchsanweisung, ein Datei Manifest (Erläutern Sie, wofür jeder wichtige Ordner dient) und eine Zusammenfassung der Lizenz.

Es ist auch üblich, einen Abschnitt einzufügen mit Informationen über den Entwickler oder das Team, mögliche Wege zur Mitarbeit am Projekt, eine Liste bekannter Fehler und eine kurze Anleitung zur Fehlerbehebung bei häufigen Problemen. All dies hilft jedem, der das Repository besucht, eine globale und praktische Vision ohne woanders suchen zu müssen.

In einigen Fällen kann die README-Datei einen kleinen Hinweis enthalten. Änderungsprotokoll oder auf eine externe Änderungsprotokolldatei verweisen. Es ist außerdem üblich, einen Abschnitt „Neuigkeiten“ oder „Was ist neu?“ einzufügen, der die relevanten Änderungen zwischen den Versionen hervorhebt, insbesondere wenn die Zielgruppe Endbenutzer und nicht Entwickler sind.

Im Kontext von akademischen Repositorien oder Datenrepositorien empfehlen viele Vorlagen zusätzlich zur Inhaltsbeschreibung auch eine Beschreibung des Inhalts. die Methodik zur Erhebung oder Erzeugung der Daten, die einbezogenen Variablen, den zeitlichen und geografischen Umfang der Informationen sowie etwaige relevante Einschränkungen bei der Verwendung oder Interpretation.

Die README-Datei als Kommunikationsmittel auf GitHub

Wenn Sie ein Projekt auf GitHub hochladen, wird die README-Datei nicht nur zur Dokumentation, sondern auch zu einem Kommunikations- und PräsentationselementTatsächlich empfiehlt die Plattform selbst, jedem öffentlichen Repository eine README-Datei hinzuzufügen, damit Besucher schnell verstehen, worum es in dem Projekt geht.

Sie können die README-Datei verwenden, um dies zu erklären. Was das Projekt bewirktWarum es nützlich sein könnte, wie man loslegt (zum Beispiel mit einem Abschnitt „Erste Schritte“), wo man Hilfe findet (Probleme, Foren, Chat usw.) und wer den Code aktiv pflegt. All das beeinflusst die wahrgenommene Qualität und das Vertrauen, das das Repository erzeugt.

In vielen Fällen nutzen Entwickler ihre GitHub-Repositories als professionelles PortfolioIn diesem Zusammenhang spielen gut gestaltete README-Dateien eine entscheidende Rolle: Sie ermöglichen es Personalverantwortlichen oder anderen Interessierten, auf einen Blick den Umfang des Projekts, die verwendeten Technologien und die Arbeitsweise des Autors zu erfassen.

Wenn es Ihnen nicht darum geht, Beiträge zu gewinnen oder das Repository zu bewerben (beispielsweise bei einem privaten oder sehr internen Projekt), ist eine sehr detaillierte README-Datei nicht zwingend erforderlich. Dennoch ist es in der Regel sinnvoll, mindestens eine zu pflegen. Mindestdokumentation Für den persönlichen Gebrauch und für Teams.

GitHub bietet außerdem einige spezielle Funktionen für die README-Datei: Es generiert automatisch ein Inhaltsverzeichnis, unterstützt Badges und Icons und ermöglicht das Einfügen von Bildern, GIFs oder Videos zur Projektpräsentation. Bei effektiver Nutzung können all diese Elemente die README-Datei deutlich verbessern. attraktiver und einfacher zu navigieren.

Wie Sie Ihre README-Datei strukturieren und verbessern

Bei der Analyse populärer Repositories (z. B. Projekte großer Technologieunternehmen oder Raumfahrtagenturen) fällt auf, dass deren README-Dateien in der Regel eine Reihe von Gemeinsamkeiten aufweisen. gemeinsame Musterobwohl jedes Projekt seine eigene visuelle und inhaltliche Identität beibehält.

Es ist üblich, einen zu finden klarer Titel und ein mögliches Coverbild (z. B. ein Logo oder Banner für das Projekt), gefolgt von einigen Symbolen, die den Projektstatus, die Lizenz, die aktuelle Version oder den Teststatus zusammenfassen. Dann folgt üblicherweise ein Projektbeschreibung, ein Abschnitt über den Status (stabil, in Entwicklung, experimentell usw.) und ein Abschnitt mit Demonstrationen oder Screenshots.

Es ist auch sehr üblich, einen Block zu finden mit Zugang zum Projekt (Links zur bereitgestellten Version, Dokumentation und veröffentlichten Paketen), eine Liste der verwendeten Technologien, Abschnitte für Mitwirkende, Entwickler und natürlich die LizenzDiese Elemente tragen dazu bei, dass die README-Datei sowohl als Kurzanleitung für Benutzer als auch als Visitenkarte für potenzielle Mitwirkende dient.

Was das Design angeht, so gibt es, obwohl es sich um eine Textdatei handelt, viel Spielraum, um sie lesbarer zu gestalten: Verwenden Sie gut strukturierte Überschriften, geordnete und ungeordnete Listen, Tabellen, wo angebracht, und Fettdruck zur Hervorhebung wichtiger IdeenIn Markdown können Sie außerdem Bilder, GIFs und kleine Dekorationen (wie Emojis) einfügen, um die Benutzerfreundlichkeit zu verbessern, wobei die Verständlichkeit stets im Auge behalten werden sollte.

Ein wenig bekannter Trick besteht darin, beim Schreiben immer an jemanden zu denken, der Er weiß absolut nichts über das Projekt.Das bedeutet, keine Vorkenntnisse vorauszusetzen, eine klare und direkte Sprache zu verwenden und Fachbegriffe beim ersten Auftreten zu erläutern. Und natürlich sollte die README-Datei stets aktualisiert werden, sobald sich etwas Relevantes im Projekt ändert.

Lizenz, Beiträge und Urheberschaft

Bei Open-Source-Projekten ist ein besonders wichtiger Abschnitt der README-Datei derjenige, der dem … gewidmet ist. LizenzDie Veröffentlichung von Code in einem öffentlichen Repository macht ihn nicht automatisch zu freier Software; es ist notwendig, explizit anzugeben, unter welchen Bedingungen er als freie Software gelten kann. zur Verwendung, Änderung und Weiterverbreitung.

Üblicherweise werden bekannte Lizenzen verwendet (z. B. MIT, Apache, GPL, Creative Commons für die Dokumentation) und in der README-Datei auf die LICENSE- oder COPYING-Datei des Repositorys verlinkt. So weiß jeder Interessierte sofort, was er mit dem Code tun darf und welche Verpflichtungen er hat (z. B. Namensnennung, Weitergabe unter gleichen Bedingungen, Haftungsbeschränkungen usw.).

Ein weiterer wichtiger Bestandteil einer ausgereiften README-Datei ist die Leitfaden für BeiträgeDieser Abschnitt erklärt, wie andere zum Projekt beitragen können: Stilrichtlinien, der Prozess zum Einreichen von Pull-Requests, wie man Fehler meldet, welche Arten von Beiträgen akzeptiert werden und wo die Arbeit koordiniert wird. Manchmal sind diese Informationen in einer separaten Datei namens CONTRIBUTING.md enthalten, die von der README-Datei verlinkt ist.

Es ist auch eine gute Praxis, die Mitwirkende Einzelpersonen und EntwicklerManche Projekte enthalten Tabellen mit Avataren und Namen, die mit den jeweiligen Profilen verlinkt sind, während andere lediglich die Hauptnutzer auflisten. Diese Geste würdigt nicht nur die geleistete Arbeit, sondern ermöglicht auch die direkte Kontaktaufnahme, falls jemand mit einem bestimmten Teammitglied sprechen möchte.

Abschließend lohnt es sich, einige Zeilen der Erklärung zu widmen Wie man Hilfe erhält Und welche Kanäle gibt es: GitHub-Issues, Foren, Mailinglisten, Chats usw. Wenn das Projekt keinen offiziellen Support anbietet, ist es ebenfalls angebracht, dies klar anzugeben, um Missverständnisse zu vermeiden.

Aus all dem Vorangegangenen wird die README-Datei zu einem zentralen Bestandteil jedes digitalen Projekts: Es erklärt, was es ist, wie es funktioniert, wer es wartet und unter welchen Bedingungen es verwendet werden kann.Sich um seine Inhalte zu kümmern und sie auf dem neuesten Stand zu halten, ist eine kleine Investition, die einen großen Unterschied darin ausmacht, wie andere Menschen seine Arbeit wahrnehmen und nutzen.