Stack

Developer Docs Stack

Developer docs/tutorial pages with TechArticle, FAQs, speakable sections, and breadcrumb context.

Open generator Validate in Rich Results Test

When to use this stack

Developer documentation articles and tutorials
API guides that need navigation context and FAQs
Docs where speakable selectors help with voice/read-out

What's included

Tech Article
Open generator
Primary doc/tutorial entity with headline, description, dates, and author.
Frequently Asked Questions
Open generator
Answer common implementation questions.
Speakable
Open generator
Optional voice-friendly selectors for key content.
Breadcrumb
Open generator
Navigation context within docs.

Required properties (stack union)

Ensure every applicable required property is present in your implementation. Nested props reference their parent objects (for example, `offers.priceCurrency`).

author.name

datePublished

description

headline

itemListElement[].name

mainEntity[].@type=Question

mainEntity[].acceptedAnswer.text

speakable.cssSelector

url

Recommended properties (stack union)

dateModified

itemListElement[].item

mainEntityOfPage

mainEntity[].acceptedAnswer.text

mainEntity[].author.name

mainEntity[].name

publisher.name

speakable.xpath

Combined JSON-LD

Paste as a single script tag. Keep product details, offer data, shipping/returns, and FAQ answers in sync with the page.

Validate

[
  {
    "@context": "https://schema.org",
    "@type": "TechArticle",
    "@id": "https://www.example.com/docs/api-auth#article",
    "headline": "API Authentication Guide",
    "description": "Learn how to authenticate with our API using API keys and OAuth.",
    "datePublished": "2026-02-18",
    "dateModified": "2026-02-18",
    "url": "https://www.example.com/docs/api-auth",
    "author": { "@type": "Person", "name": "Casey Lin" },
    "publisher": { "@type": "Organization", "name": "Example Dev" }
  },
  {
    "@context": "https://schema.org",
    "@type": "FAQPage",
    "mainEntity": [
      {
        "@type": "Question",
        "name": "Where do I get an API key?",
        "acceptedAnswer": {
          "@type": "Answer",
          "text": "Create a key from your account under Settings → API Keys. Keep it secret and rotate regularly."
        }
      },
      {
        "@type": "Question",
        "name": "Do you support OAuth?",
        "acceptedAnswer": {
          "@type": "Answer",
          "text": "Yes. Use our OAuth 2.0 flow for user-delegated access. See the OAuth section below for scopes."
        }
      }
    ]
  },
  {
    "@context": "https://schema.org",
    "@type": "WebPage",
    "speakable": {
      "@type": "SpeakableSpecification",
      "cssSelector": [
        "h1",
        ".doc-summary"
      ]
    }
  },
  {
    "@context": "https://schema.org",
    "@type": "BreadcrumbList",
    "itemListElement": [
      { "@type": "ListItem", "position": 1, "name": "Home", "item": "https://www.example.com" },
      { "@type": "ListItem", "position": 2, "name": "Docs", "item": "https://www.example.com/docs" },
      { "@type": "ListItem", "position": 3, "name": "API Authentication", "item": "https://www.example.com/docs/api-auth" }
    ]
  }
]

Implementation steps

Start from your live product detail page content; ensure titles, prices, and availability match the page.
Embed one JSON-LD script in the head or just before the closing body tag using the combined example as a template.
Fill shipping details for each region you serve and keep them aligned with on-page shipping tables.
Attach your canonical MerchantReturnPolicy URL and keep the policy text in sync with Merchant Center.
Add 3–6 FAQs that address purchase blockers (shipping, returns, compatibility) and keep answers consistent with visible content.
Validate in the Rich Results Test and revalidate after price/availability/policy changes.

Common errors and fixes

Missing currency or availability: ensure `offers.priceCurrency` and `offers.availability` use ISO currency codes and schema URLs.
ShippingDetails missing destination or transit time: include `shippingDestination.addressCountry` and `deliveryTime.transitTime` with units.
MerchantReturnPolicy not linked: reference it from the Offer via `hasMerchantReturnPolicy` and provide a stable policy URL.
FAQ answers don't match the page: keep FAQ content identical to visible answers to avoid review or manual actions.

FAQs

Do I have to include Speakable?

No. Use it if you want voice/read-out; otherwise remove the speakable object.

Should I use TechArticle or Article?

Use TechArticle for technical docs; use Article for general content. Keep fields aligned to the page.

SwiftSchema

Intuitive Schema Generation at Your Fingertips