Führungslinien für Formatvorlagen und Inhaltsmodell

Befolge diesen Styleguide, damit die GitHub-Dokumentation einheitlich bleibt und klaren Mustern folgt, die für die Leser*innen leicht verständlich sind.

Das Inhaltsmodell beschreibt die Struktur und die Inhaltstypen, die wir veröffentlichen.

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

Verwenden Sie Themen, um Artikel durchsuchbar zu machen.

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

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

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

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.

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.

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.

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

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