Docsbook
Übersicht

JSON-LD für Dokumentation: relevante Schema-Typen

JSON-LD sind in Ihr HTML eingebettete strukturierte Daten, die Suchmaschinen und KI-Agenten darüber informieren, welche Art von Inhalt sich auf der Seite befindet. Für Dokumentationen machen die richtigen Schema-Typen den Seitentyp, die Schritte, die Breadcrumbs und die Produktidentität maschinenlesbar, anstatt sie lediglich durch das Layout anzudeuten.

Dieser Beitrag listet die hinzufügenswerten Schema-Typen auf, nennt den Typ, dessen Rich Result Google inzwischen eingeschränkt hat, und enthält funktionierende Beispiele. Er verspricht weder ein besseres Ranking noch eine Zitierung: Keine der geprüften Techniken hat eine stabile, plattformübergreifende kausale Wirkung auf eines von beidem.

TL;DR#

Schema Verwendet für Warum es wichtig ist
TechArticle Anleitungs- und Tutorialseiten Teilt Google mit: „Dies sind technische Inhalte“
FAQPage Jede Seite mit Q&A Maschinenlesbare Q&A-Paare – aber für die meisten Websites kein Rich Result, siehe unten
HowTo Schritt-für-Schritt-Anleitungen Rich Results für Schritt-für-Schritt-Anleitungen in Google
SoftwareApplication Produktübersichtsseite Preis, Bewertungen und Betriebssystem werden angezeigt
Article Blogbeiträge und Ankündigungen Standard-Rich-Results für Artikel
BreadcrumbList Jede Dokumentationsseite Brotkrümelnavigation in den Suchergebnissen
WebSite Website-Stammverzeichnis SiteSearchAction aktiviert das Google-Suchfeld

Wenn Sie nur eines tun, implementieren Sie TechArticle und BreadcrumbList. Docsbook fügt diese automatisch hinzu.

Warum JSON-LD gegenüber Microdata oder RDFa#

JSON-LD überzeugt, weil:

  1. Es ein separater <script>-Block ist, der von deinem HTML-Markup entkoppelt ist
  2. Google es ausdrücklich bevorzugt („empfohlen“ in der Dokumentation)
  3. Einfacher zu pflegen – Schema ändern, ohne das Layout anzufassen
  4. KI-Agenten es zuverlässiger analysieren als Inline-Markup

Microdata und RDFa funktionieren weiterhin, gelten aber im Jahr 2026 als veraltet.

TechArticle: der Standard für Dokumentationen#

Für die meisten Dokumentationsseiten ist TechArticle das richtige Schema:

<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "TechArticle",
  "headline": "How to authenticate with OAuth",
  "description": "Step-by-step guide to authenticating users with OAuth 2.0",
  "author": {
    "@type": "Organization",
    "name": "Acme",
    "url": "https://acme.com"
  },
  "datePublished": "2026-01-15",
  "dateModified": "2026-03-20",
  "publisher": {
    "@type": "Organization",
    "name": "Acme",
    "logo": {
      "@type": "ImageObject",
      "url": "https://acme.com/logo.png"
    }
  },
  "mainEntityOfPage": "https://docs.acme.com/auth/oauth"
}
</script>

Das erhalten Sie dadurch:

  • Google kennzeichnet die Seite als maßgeblichen technischen Inhalt
  • KI-Agenten neigen dazu, mit TechArticle gekennzeichnete Seiten in Zitaten höher zu gewichten
  • dateModified teilt Crawlern mit, dass die Seite aktuell ist

FAQPage: Rich-Snippets-Gold#

Wenn Ihre Seite eine Q&A-Struktur hat, sorgt das FAQPage-Schema dafür, dass Google diese Q&As direkt in den Suchergebnissen anzeigt.

<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "FAQPage",
  "mainEntity": [{
    "@type": "Question",
    "name": "How do I revoke an API key?",
    "acceptedAnswer": {
      "@type": "Answer",
      "text": "Open the dashboard, navigate to API Keys, find the key, click Revoke. Revocation is immediate."
    }
  }, {
    "@type": "Question",
    "name": "Can I have multiple API keys?",
    "acceptedAnswer": {
      "@type": "Answer",
      "text": "Yes. Replace this answer with the real limit from your own product."
    }
  }]
}
</script>

Erzeugt das FAQPage-Markup in Google weiterhin ein Rich Result?#

Für fast alle Dokumentationsseiten: nein. Google hat das FAQ-Rich-Result 2023 eingeschränkt, und in der eigenen Dokumentation steht inzwischen, dass das Feature „nur für bekannte, maßgebliche Websites von Regierungsbehörden und aus dem Gesundheitswesen angezeigt wird“ (Google Search Central, strukturierte Daten für FAQPage, gelesen am 03.09.2026). Jeder Leitfaden, der einen Anstieg der Klickrate durch FAQ-Snippets auf einer Produktdokumentationsseite verspricht, beschreibt die Welt vor 2023.

Das ist kein Grund, das Markup zu löschen. FAQPage kann nach wie vor eines gut: Es legt in einer Form, die ein Parser nicht missverstehen kann, fest, dass dieser Block eine Frage und jener Block die Antwort darauf ist. Behalten Sie es dort bei, wo die Seite tatsächlich eine Liste von Fragen und Antworten ist, und erwarten Sie keine visuelle Änderung in Google.

HowTo: Schritt-für-Schritt-Anleitungen#

Wenn Sie eine nummerierte Schritt-für-Schritt-Anleitung haben, verwenden Sie HowTo:

<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "HowTo",
  "name": "Set up a custom domain for documentation",
  "step": [{
    "@type": "HowToStep",
    "text": "Open the dashboard and go to Settings → Domain"
  }, {
    "@type": "HowToStep",
    "text": "Enter your subdomain (docs.yourcompany.com)"
  }, {
    "@type": "HowToStep",
    "text": "Add a CNAME record in DNS pointing to cname.vercel-dns.com"
  }, {
    "@type": "HowToStep",
    "text": "Wait for SSL to provision (under 5 minutes)"
  }]
}
</script>

Ergebnis: Google zeigt möglicherweise Rich-Suchergebnisse mit erweiterten einzelnen Schritten an.

SoftwareApplication: Produktseite#

Ihre Produktübersichtsseite sollte als SoftwareApplication gekennzeichnet werden:

<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "SoftwareApplication",
  "name": "Acme",
  "applicationCategory": "DeveloperApplication",
  "operatingSystem": "Web",
  "offers": {
    "@type": "Offer",
    "price": "150",
    "priceCurrency": "USD"
  },
  "aggregateRating": {
    "@type": "AggregateRating",
    "ratingValue": "4.8",
    "ratingCount": "247"
  }
}
</script>

Dadurch werden Preise und Bewertungen in den Rich-Suchergebnissen von Google angezeigt. Seien Sie bei Bewertungen ehrlich – Google bestraft überhöhte aggregateRating.

BreadcrumbList: jede Seite#

Jede Seite sollte Breadcrumbs in JSON-LD enthalten. Google zeigt sie in den Suchergebnissen an, KI-Agenten verwenden sie, um die Hierarchie zu verstehen:

<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "BreadcrumbList",
  "itemListElement": [{
    "@type": "ListItem",
    "position": 1,
    "name": "Docs",
    "item": "https://docs.acme.com"
  }, {
    "@type": "ListItem",
    "position": 2,
    "name": "Authentication",
    "item": "https://docs.acme.com/auth"
  }, {
    "@type": "ListItem",
    "position": 3,
    "name": "OAuth",
    "item": "https://docs.acme.com/auth/oauth"
  }]
}
</script>

Geben Sie auf Ihrer Startseite die Websitesuche an:

<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "WebSite",
  "url": "https://docs.acme.com",
  "potentialAction": {
    "@type": "SearchAction",
    "target": "https://docs.acme.com/search?q={search_term_string}",
    "query-input": "required name=search_term_string"
  }
}
</script>

Dadurch wird das Suchfeld direkt unter Ihrem Ergebnis in Google freigeschaltet.

Mehrere Schemata auf einer Seite#

Sie können Schemata stapeln. Eine Dokumentationsseite könnte Folgendes enthalten:

  • TechArticle für den Inhaltstyp
  • BreadcrumbList für die Navigation
  • FAQPage, wenn es einen Q&A-Abschnitt gibt

Alle drei in drei separaten <script type="application/ld+json">-Blöcken. Google liest sie alle.

Was KI-Agenten mit JSON-LD machen#

Drei beobachtete Verhaltensweisen:

  1. Typfilterung — Agenten, die nach Tutorials suchen, bevorzugen TechArticle und HowTo gegenüber Article
  2. Extraktionsabkürzungen — Das FAQPage-Schema wird nahezu wortgetreu extrahiert
  3. Vertrauenssignale — Schemata mit korrektem Organization und publisher werden höher gewichtet

So liefert Docsbook JSON-LD aus#

Docsbook fügt automatisch Folgendes hinzu:

  • TechArticle auf jeder Dokumentationsseite
  • BreadcrumbList auf jeder Seite
  • FAQPage auf Seiten, auf denen Q&A-Muster erkannt werden
  • SoftwareApplication auf Ihrer Startseite, wenn Metadaten bereitgestellt werden
  • WebSite mit SearchAction zur Stammseite der Website

Keine Konfiguration erforderlich. Das Schema wird aus Ihrem vorhandenen Markdown und Frontmatter erstellt.

Validierung#

Zwei Tools:

  • Google Rich Results Test — https://search.google.com/test/rich-results
  • Schema.org-Validator — https://validator.schema.org/

Führen Sie beide für Ihre Dokumentationsseiten aus. Beheben Sie alle Warnungen. Fehler blockieren die Verarbeitung; Warnungen nicht.

Docsbook fügt automatisch auf jeder Seite JSON-LD hinzu. Veröffentlichen Sie Ihre Dokumentation →

Updated

War diese Seite hilfreich?

Powered by Docsbook