Schreiben für die GitHub-Dokumentation

Orientieren Sie sich an diesen bewährten Methoden, um Dokumente zu erstellen, die benutzerfreundlich und leicht verständlich sind.

Unsere Dokumentationsphilosophie dient als Leitfaden zur Erstellung von Inhalten.

Unsere Dokumentation wird in mehrere Sprachen übersetzt. Die Vorgehensweise beim Schreiben der englischsprachigen Dokumentation kann die Qualität dieser Übersetzungen erheblich verbessern.

Wir stellen diese Prinzipien für das Entwerfen und Erstellen der besten Inhalte den Personen zur Verfügung, die GitHub verwenden.

GitHub Docs verwendet Titelei- und Liquid-Operatoren von YAML, um mehrere Versionen von GitHub mit einem Single-Source-Ansatz zu unterstützen.

Du kannst Markdown und Liquid verwenden, um Inhalte zu formatieren, wiederverwendbare Inhalte zu erstellen und Inhalte für verschiedene Versionen auf GitHub Docs zu schreiben.

Sie können die YAML-Titelei verwenden, um die Versionsverwaltung zu definieren, Metadaten hinzuzufügen und das Layout für Artikel zu steuern.

In diesem Leitfaden wird erläutert, wie Sie Videos erstellen, die die Benutzeranforderungen für GitHub Docs unterstützen.

Du kannst wiederverwendbare Inhalte erstellen, auf die in mehreren Inhaltsdateien verwiesen werden kann.

Du kannst Benutzer*innen helfen, schwer auffindbare Elemente auf der Benutzeroberfläche zu finden, indem du Screenshots zu GitHub Docs hinzufügst.

In diesem Leitfaden wird erläutert, wann und wie du Diagramme erstellst, die die Benutzeranforderungen für GitHub Docs unterstützen.

Du kannst Toolumschalter verwenden, um anzuzeigen, wie Aufgaben mithilfe bestimmter Tools ausgeführt werden.

Wenn sich der Titel, die Version oder der Speicherort eines Artikels ändert, können Sie eine Umleitung zum aktuellen Inhalt erstellen.

Wenn der Titel eines Artikels geändert werden muss, muss der Name möglicherweise an mehreren Stellen aktualisiert werden.

Du kannst Codebeispiele mit Anmerkungen versehen, um zu erläutern, wie sie funktionieren und wie sie für andere Zwecke angepasst werden können.

Dieser Artikel enthält Startvorlagen für die verschiedenen Inhaltstypen, die in GitHub Docs verwendet werden.