Skip to main content

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.

Führungslinien für Formatvorlagen und Inhaltsmodell

Erfahren Sie, wie wir die Dokumentation von GitHub konsistent, einfach zu verfolgen und Standard nachhaltig halten.

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.

Inhalt eines GitHub-Docs-Artikels

Jeder Artikel enthält einige Standardelemente und kann konditionale oder optionale Elemente enthalten. Wir verwenden auch eine Standardreihenfolge für Inhalte innerhalb eines Artikels.

Informationen zu Themen

Verwenden Sie Themen, um Artikel durchsuchbar zu machen.

Konzeptioneller Inhaltstyp

Personen verwenden am häufigsten konzeptionelle Inhalte, wenn sie etwas Neues lernen.

Referenzieller Inhaltstyp

Referenzielle Inhalte bieten detaillierte Informationen, die Personen benötigen, wenn sie ein Feature aktiv nutzen.

Prozeduraler Inhaltstyp

Prozedurale Inhalte bieten Kontext darüber, welche Bedeutung eine Aufgabe für das übergeordnete Ziel einer Person hat.

Inhaltstyp zur Problembehandlung

Inhalte zur Problembehandlung umfassen integrierte Fehler, die bei Benutzerinnen auftreten, oft an den Support gemeldete, gängige Probleme sowie Situationen, in denen sich Benutzerinnen beim Abschließen von Aufgaben befinden können.

Inhaltstyp der Versionshinweise

Mithilfe von Versionshinweisen können Leserinnen die Änderungen für Benutzerinnen in jedem Release der versionierten Enterprise-Produkte von GitHub verstehen und sich darauf vorbereiten.

Schnellstart-Inhaltstyp

Schnellstarts eignen sich am besten für Personen, die Anweisungen schnell ohne ausführliche Erklärungen darüber wünschen, wie etwas funktioniert oder warum sie es verwenden möchten.

Lernprogramminhaltstyp

Tutorials sind nützlich, wenn jemand ein grundlegendes Verständnis des Produkts hat und sein Wissen erweitern möchte, um ein bestimmtes Problem zu beheben

Über die Kombination mehrerer Inhaltstypen

Sie können mehrere Inhaltstypen in einem einzigen Artikel kombinieren, um Personen bei der Durchführung komplexer Aufgaben zu unterstützen.