Mitwirken an der GitHub-Dokumentation
Hier erfährst du, wie das GitHub Docs-Team die Dokumentation erstellt und wie du mitwirken kannst.
Empfohlen
Informationen zur Mitwirkung an der GitHub-Dokumentation
Du kannst auf verschiedene Weise zu Inhalten der GitHub-Dokumentation beitragen.
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.
Stil-Leitfaden
Befolge diesen Styleguide, damit die GitHub-Dokumentation einheitlich bleibt und klaren Mustern folgt, die für die Leser*innen leicht verständlich sind.
Artikel
Ä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.
Arbeiten an GitHub-Dokumentationen in einem Codespace
Du kannst GitHub Codespaces verwenden, um an der Dokumentation für GitHub Docs zu arbeiten.
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.
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.
Bezeichnungsreferenz
Bezeichnungen können dir helfen, ein Issue zu finden, bei dem du helfen möchtest.
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.
Erstellen einer lokalen Umgebung
Du kannst die Anwendung GitHub Docs lokal auf deinem Computer ausführen.
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.
Anzeigen 1 bis 9 von 37