SwiftSchemaGenerate
    Schema stack

    Developer Docs Stack

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

    Open generatorValidate in Rich Results Test
    Included schema
    Tech Article
    Frequently Asked Questions
    Speakable
    Breadcrumb
    Fit

    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
    Composition

    What is included

    Data contract

    Properties across the bundle

    Nested properties keep their parent path, such as offers.priceCurrency. Only publish values that match visible page content.

    Required properties

    • author.name
    • datePublished
    • description
    • headline
    • itemListElement[].name
    • mainEntity[].@type=Question
    • mainEntity[].acceptedAnswer.text
    • speakable.cssSelector
    • url

    Recommended properties

    • dateModified
    • itemListElement[].item
    • mainEntityOfPage
    • mainEntity[].acceptedAnswer.text
    • mainEntity[].author.name
    • mainEntity[].name
    • publisher.name
    • speakable.xpath
    Copy-ready example

    Combined JSON-LD

    Paste this as one script tag, then replace every example value with data from the live 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" }
    ]
  }
]
    Workflow

    Implement and verify

    1. 01

      Start with the live page

      Confirm titles, prices, availability, policies, and visible FAQ content before generating markup.

    2. 02

      Add one JSON-LD script

      Use the combined example as a template in the document head or before the closing body tag.

    3. 03

      Complete regional details

      Fill shipping destinations and timing for every region the page actually serves.

    4. 04

      Link the return policy

      Use a stable MerchantReturnPolicy URL and keep its terms synchronized with the page.

    5. 05

      Match visible answers

      Add only FAQs that users can read on the same page, with identical answers.

    6. 06

      Validate after changes

      Run Rich Results Test after implementation and whenever price, availability, or policy data changes.

    Quality check

    Common errors and fixes

    • Missing currency or availability

      Use ISO currency codes and complete schema.org availability URLs in Offer data.

    • Incomplete shipping details

      Include shippingDestination.addressCountry and deliveryTime.transitTime with units.

    • Return policy is not connected

      Reference MerchantReturnPolicy from the Offer and provide a stable public policy URL.

    • FAQ answers differ from the page

      Keep structured FAQ answers identical to visible answers.

    Questions

    Stack 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.

    Primary sources

    References