Diese Version von GitHub Enterprise Server wird eingestellt am 2026-04-09. 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.

Vorgehensweise: Inhaltstyp

Erläutern, wie Eine Aufgabe mithilfe von GitHub Produkten und Features abgeschlossen werden kann.

In diesem Artikel

Anleitungen enthalten nummerierte Schritte, die beschreiben, wie GitHub Produkte verwendet werden, um eine Aufgabe auszuführen. Im Allgemeinen sind sie erforderlich, um GitHub optimal zu nutzen.

Artikel mit Anleitungen konzentrieren sich auf die minimalen wesentlichen Schritte zum Ausführen einer Aufgabe. Sie können auf andere Inhaltstypen als Voraussetzungen (insbesondere Konzepte oder Referenzen) oder als nächste Schritte (insbesondere Tutorials) verweisen. Im Einklang mit unserer Verknüpfungsstrategie sollten diese nur dann verwendet werden, wenn sie explizit nützlich und notwendig sind.

In der Regel ist es in Ordnung, 1-2 kurze Einleitungssätze vor den Schritten einzufügen. Wenn eine weitere Erläuterung über ein paar Sätze hinaus erforderlich ist, sollten Sie die Informationen stattdessen als konzeptuellen Artikel hinzufügen.

Bei der Problembehandlung handelt es sich um einen eigenen Inhaltstyp, aber Anleitungsartikel können kurze Problembehandlungsabschnitte enthalten, in denen die Benutzer die Aufgabe ausführen können.

Titel für Artikel mit Anleitungen

Artikeltitel und Abschnitte innerhalb von Artikeln sind aufgabenbasiert und beginnen mit einem Gerund.

  • Verwendung: "Bewerben um ein Studentenentwicklerpaket" Verwenden Sie aktive und präzise Verben (bei Bedarf Brainstorming oder einen Thesaurus verwenden). Titel beschreiben ausdrücklich die Aufgabe, die im Artikel oder der Überschrift enthalten ist, sind jedoch allgemein genug, um den gesamten Inhalt widerzuspiegeln.

Kurztitel für Artikel mit Anleitungen verwenden kurze, nicht gerundte Verbsätze. Kurze Titel werden in der Randleistennavigation angezeigt.

  • Verwenden Sie: "Verwalten Ihres Plans" oder "Erstellen von Problemen mit Copilot"

Überlegungen zu Anleitungen

Informationen zur Vorgehensweisen-Inhaltsvorlage finden Sie unter Vorlagen.

  • Befolge die Stilrichtlinien für prozedurale Schritte unter Stil-Leitfaden.
  • Vorgehensweisen können sich wiederholen – suchen Sie nach Möglichkeiten zum Gruppieren verwandter Inhalte in einem einzelnen längeren Artikel.
    • Gruppieren Sie mehrere verwandte Anleitungen in einem einzigen Artikel, es sei denn, es gibt einen zwingenden Grund, es nicht zu tun.
    • Wenn das Deaktivieren einer Einstellung oder das Rückgängigmachen einer Aufgabe dieselben Schritte erfordert und keine besonderen Auswirkungen hat, schreiben Sie keine separate Vorgehensweise.
    • Wenn das Deaktivieren einer Einstellung oder das Rückgängigmachen einer Aufgabe unterschiedliche Schritte erfordert oder wichtige oder besondere Auswirkungen hat, erstellen Sie einen längeren Artikel, um beide Vorgehensweisen zu enthalten.
  • Geben Sie immer das beabsichtigte Ergebnis der Anleitung an (im Allgemeinen ist dies der Titel).
  • Fügen Sie Tipps zur Problembehandlung in bekannte Schmerzpunkte ein.

Beispiele für Anleitungen

  •         [AUTOTITLE](/actions/using-workflows/using-starter-workflows)