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 konzeptionelle Artikel und konzeptionelle Abschnitte in anderen Artikeln. Die meisten wichtigen Produkte, Features oder Themen bieten einen eigenen konzeptionellen Artikel.
Schreiben von konzeptionellen Inhalten
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.
- Beschreiben Sie ggf. die Funktionsweise des Features oder Themas (dabei auf die Zielgruppe und die richtige Positionierung von technischen Details achten).
- Heben Sie alle Details hervor, die die Leser*innen beachten müssen, um das Feature verwenden zu können.
- Schließen Sie Informationen zu den nächsten Schritte mit dem Feature ein (sei es durch Links zu weiteren Artikeln oder Inhalte im Artikel selbst).
Titel für konzeptionelle Inhalte
- Konzeptionelle Artikel oder Überschriften für konzeptionelle Abschnitte beginnen mit „Informationen zu [Thema]“.
- Verwenden Sie ein Substantiv, um das Thema zu beschreiben.
- Verwenden Sie Sie beispielsweise „Informationen zum 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