Diese Version von GitHub Enterprise Server wurde eingestellt am 2024-09-25. Es wird keine Patch-Freigabe vorgenommen, auch nicht für kritische Sicherheitsprobleme. Für bessere Leistung, verbesserte Sicherheit und neue Features aktualisiere auf die neueste Version von GitHub Enterprise Server. Wende dich an den GitHub Enterprise-Support, um Hilfe zum Upgrade zu erhalten.
Schreiben für die GitHub-Dokumentation
Erfahren Sie mehr über das Schreiben für GitHub Docs.
Bewährte Methoden für GitHub-Dokumente
Orientieren Sie sich an diesen bewährten Methoden, um Dokumente zu erstellen, die benutzerfreundlich und leicht verständlich sind.
Informationen zur Dokumentationsphilosophie von GitHub
Unsere Dokumentationsphilosophie dient als Leitfaden zur Erstellung von Inhalten.
Inhaltsentwurfsprinzipien
Wir stellen diese Prinzipien für das Entwerfen und Erstellen der besten Inhalte den Personen zur Verfügung, die GitHub verwenden.
Schreiben von zu übersetzenden Inhalten
Unsere Dokumentation wird in mehrere Sprachen übersetzt. Die Vorgehensweise beim Schreiben der englischsprachigen Dokumentation kann die Qualität dieser Übersetzungen erheblich verbessern.
Auffindbar machen von Inhalten in der Suche
Halten Sie sich an diese bewährten SEO-Methoden, damit Benutzer die Dokumentation zu GitHub mithilfe von Suchmaschinen einfacher finden können.
Dokumentation zur Versionierung
GitHub Docs verwendet Titelei- und Liquid-Operatoren von YAML, um mehrere Versionen von GitHub mit einem Single-Source-Ansatz zu unterstützen.
Verwenden von Markdown und Liquid in GitHub Docs
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.
Verwenden einer YAML-Titelei
Sie können die YAML-Titelei verwenden, um die Versionsverwaltung zu definieren, Metadaten hinzuzufügen und das Layout für Artikel zu steuern.
Verwenden von Videos in GitHub-Dokumentationen
In diesem Leitfaden wird erläutert, wie Sie Videos erstellen, die die Benutzeranforderungen für GitHub Docs unterstützen.
Erstellen von wiederverwendbarem Inhalt
Du kannst wiederverwendbare Inhalte erstellen, auf die in mehreren Inhaltsdateien verwiesen werden kann.
Erstellen von Screenshots
Du kannst Benutzer*innen helfen, schwer auffindbare Elemente auf der Benutzeroberfläche zu finden, indem du Screenshots zu GitHub Docs hinzufügst.
Erstellen von Diagrammen für GitHub Docs
In diesem Leitfaden wird erläutert, wann und wie du Diagramme erstellst, die die Benutzeranforderungen für GitHub Docs unterstützen.
Erstellen von Toolumschaltern in Artikeln
Du kannst Toolumschalter verwenden, um anzuzeigen, wie Aufgaben mithilfe bestimmter Tools ausgeführt werden.
Konfigurieren von Umleitungen
Wenn sich der Titel, die Version oder der Speicherort eines Artikels ändert, können Sie eine Umleitung zum aktuellen Inhalt erstellen.
Ändern eines Artikeltitels
Wenn der Titel eines Artikels geändert werden muss, muss der Name möglicherweise an mehreren Stellen aktualisiert werden.
Anmerkungen zu Codebeispielen
Du kannst Codebeispiele mit Anmerkungen versehen, um zu erläutern, wie sie funktionieren und wie sie für andere Zwecke angepasst werden können.
Vorlagen
Dieser Artikel enthält Startvorlagen für die verschiedenen Inhaltstypen, die in GitHub Docs verwendet werden.