SwiftSchemaGenerate
    Schema stack

    Documentation Search Stack

    Doc search portals with WebSite + SearchResultsPage context, FAQs, and breadcrumb navigation.

    Open generatorValidate in Rich Results Test
    Included schema
    Website
    Search Results Page
    Frequently Asked Questions
    Breadcrumb
    Fit

    When to use this stack

    • Documentation search landing pages (sitewide docs search)
    • Search results pages for developer docs and guides
    • Pages where FAQs clarify indexing, scope, and result freshness
    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

    • itemListElement[].name
    • mainEntity[].@type=Question
    • mainEntity[].acceptedAnswer.text
    • name
    • url

    Recommended properties

    • description
    • itemListElement[].item
    • mainEntity[].acceptedAnswer.text
    • mainEntity[].author.name
    • mainEntity[].name
    • potentialAction.query-input
    • potentialAction.target
    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": "WebSite",
    "@id": "https://www.example.com/docs#website",
    "name": "Example Docs",
    "url": "https://www.example.com/docs",
    "potentialAction": {
      "@type": "SearchAction",
      "target": "https://www.example.com/docs/search?q={search_term_string}",
      "query-input": "required name=search_term_string"
    }
  },
  {
    "@context": "https://schema.org",
    "@type": "SearchResultsPage",
    "@id": "https://www.example.com/docs/search#page",
    "name": "Search Docs",
    "description": "Search API references, guides, and tutorials.",
    "url": "https://www.example.com/docs/search"
  },
  {
    "@context": "https://schema.org",
    "@type": "FAQPage",
    "mainEntity": [
      {
        "@type": "Question",
        "name": "What does the search index include?",
        "acceptedAnswer": {
          "@type": "Answer",
          "text": "All public API reference, tutorials, changelog entries, and guides are indexed."
        }
      },
      {
        "@type": "Question",
        "name": "How fresh are the results?",
        "acceptedAnswer": {
          "@type": "Answer",
          "text": "Docs are reindexed hourly. Newly published pages appear within 60 minutes."
        }
      },
      {
        "@type": "Question",
        "name": "Do you support operators or filters?",
        "acceptedAnswer": {
          "@type": "Answer",
          "text": "Use filters in the UI for product area, version, and date. Boolean operators are not supported."
        }
      }
    ]
  },
  {
    "@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": "Search", "item": "https://www.example.com/docs/search" }
    ]
  }
]
    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 need both WebSite and SearchResultsPage?

    Yes. WebSite defines the docs domain and search action; SearchResultsPage labels the results page itself.

    Can I include live results?

    If you show a default query, ensure the on-page content matches what is returned and align JSON-LD URLs to the visible page.

    Primary sources

    References