Mitwirken an der GitHub-Dokumentation
Hier erfährst du, wie das GitHub Docs-Team die Dokumentation erstellt und wie du mitwirken kannst.
Beginne hier
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.
Styleguide
Befolge diesen Styleguide, damit die GitHub-Dokumentation einheitlich bleibt und klaren Mustern folgt, die für die Leser*innen leicht verständlich sind.
Informationen zum Inhaltsmodell
Das Inhaltsmodell beschreibt die Struktur und die Inhaltstypen, die wir veröffentlichen.
Informationen zur Mitwirkung an der GitHub-Dokumentation
Du kannst auf verschiedene Weise zu Inhalten der GitHub-Dokumentation beitragen.
Schreiben für die GitHub-Dokumentation
- Bewährte Methoden für GitHub-Dokumente
- Informationen zur Dokumentationsphilosophie von GitHub
- Grundlegendes zur Dokumentation von GitHub
- Inhaltsentwurfsprinzipien
- Schreiben von zu übersetzenden Inhalten
- Auffindbar machen von Inhalten in der Suche
- Dokumentation zur Versionierung
- Verwenden von Markdown und Liquid in GitHub Docs
- Verwenden einer YAML-Titelei
- Verwenden von Videos in GitHub-Dokumentationen
- Erstellen von wiederverwendbarem Inhalt
- Erstellen von Screenshots
- Erstellen von Diagrammen für GitHub Docs
- Erstellen von Toolumschaltern in Artikeln
- Konfigurieren von Umleitungen
- Ändern eines Artikeltitels
- Anmerkungen zu Codebeispielen
- Vorlagen
Führungslinien für Formatvorlagen und Inhaltsmodell
- Styleguide
- Informationen zum Inhaltsmodell
- Inhalt eines GitHub-Docs-Artikels
- Informationen zu Themen
- Konzeptioneller Inhaltstyp
- Referenzieller Inhaltstyp
- Prozeduraler Inhaltstyp
- Inhaltstyp zur Problembehandlung
- Inhaltstyp der Versionshinweise
- Schnellstart-Inhaltstyp
- Lernprogramminhaltstyp
- Über die Kombination mehrerer Inhaltstypen