Referenzieller Inhaltstyp

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

In diesem Artikel

Wir erstellen Referenzartikel und referenzielle Abschnitte innerhalb anderer Artikel.

  • Einige Hauptthemen erfordern möglicherweise einen eigenen referenziellen Artikel, insbesondere wenn eine große Menge an referenziellem Inhalt vorhanden ist (z. B. für die Suchsyntax oder die YAML-Syntax in GitHub Actions).
  • Verwenden Sie Sie für kleinere Inhaltsmengen oder spezifischere Informationen (z. B. eine Liste der unterstützten Sprachen oder Hardwareanforderungen eines Features) referenzielle Abschnitte im Kontext in prozeduralen oder konzeptionellen Artikeln.

Schreiben referenzieller Inhalte

Die Vorlage für referenzielle Inhalte findest du unter Vorlagen.

  • Schreiben Sie einen Satz oder einen gesamten konzeptionellen Abschnitt, um eine Einleitung in den referenziellen Inhalt zu bieten.
  • Verwenden Sie für den eigentlichen referenziellen Inhalt klare und konsistente Formulierungen.
  • Verwenden Sie für Themen mit einem einzelnen zu erklärenden Element eine Liste.
  • Verwenden Sie für Themen mit mehreren zu erklärenden Elementen eine Tabelle.
  • Verwenden Sie Überschriften für umfassendere referenzielle Inhalte (z. B. YAML-Syntax für Workflows) auf konsistente Weise.

Titel für referenzielle Inhalte

  • Referenzartikel oder Überschriften von referenziellen Abschnitten bieten eine klare Beschreibung des Inhalts des Abschnitts und beginnen in der Regel mit Nomen.
  • Titel enthalten genügend Informationen, um Anfänger*innen ausreichend Details zum Inhalt zu bieten und den Inhalt der einzelnen Abschnitte vollständig zu beschreiben.
  • Bei Titeln werden Aneinanderreihungen von Nomen vermieden. Verwenden Sie Präpositionen, um längere Ketten von Nomen aufzuteilen.

Beispiele für referenzielle Inhalte