Konzeptionelle Inhalte helfen den Benutzer*innen, ein Feature oder Thema zu verstehen, indem sie neben Anwendungsfällen und Beispielen eine klare, allgemeine Übersicht bzw. Erläuterungen dazu bieten, wie das Feature oder Thema ihnen helfen kann.
Wir erstellen Konzepte artikel und konzeptionelle Abschnitte in anderen Artikeln. Die meisten wichtigsten Produkte, Features oder Themen haben einen eigenen Artikel zu Konzepten.
Entscheiden zwischen einem Artikel oder einem Abschnitt
Anleitungen oder Lernprogramme können vor den Schritten 1-2 kurze Einführungssätze enthalten. Wenn mehr Erläuterungen über ein paar Sätze hinaus erforderlich sind, sollten wir überlegen, ob es in einem Konzeptartikel einen Punkt verdient.
Wir sollten jedoch selektiv sein. Nicht jedes Konzept oder der Abschnitt "Info X" benötigt einen eigenen Artikel. Im Allgemeinen hängt dies davon ab, wie viele Informationen für den Benutzer nützlich sein werden, den wir einbeziehen müssen.
Wie man konzeptionellen Inhalt schreibt
Die konzeptionelle Inhaltsvorlage findest du unter Vorlagen.
- Beschreibe in einfacher Sprache, worum es sich bei dem Feature, das Produkt oder Thema handelt.
- Beschreiben Sie den Zweck und den Nutzen für die Leser*innen.
- Stellen Sie Anwendungsfälle oder Beispiele bereit.
Titel für konzeptionelle Inhalte
Kurze Titel für Artikel sollten aus einem Wort oder einer Nominalphrase bestehen. Wenn die Artikel in der Seitenleiste unter „Concepts“ angezeigt werden, vermeiden Sie die Verwendung von „About“, es sei denn, der Artikel erscheint unter einer gleichnamigen Überschrift. Beispiel: „Programmier-Agent“ und „Informationen zum Programmier-Agent“.
Kopfzeilen konzeptioneller Abschnitte in Artikeln beginnen mit "Info [Betreff]".
- Verwenden Sie ein Substantiv, um das Thema zu beschreiben.
- Verwenden Sie: „Info zu code scanning“
- Vermeiden Sie beispielsweise „Informationen zum Überprüfen von Code auf Sicherheitsrisiken“.
Beispiele für konzeptionelle Inhalte
- Konzeptionelle Beiträge
- Konzeptionelle Abschnitte in anderen Artikeln
- „Informationen zu Sicherheitsrichtlinien“ in Hinzufügen einer Sicherheitsrichtlinie für dein Repository
- „Informationen zum Wartungsmodus“ in Wartungsmodus aktivieren und planen