SwiftSchemaGenerate
    Schema stack

    Onboarding / Setup Guide Stack

    Onboarding and setup guides with HowTo, TechArticle, FAQs, and breadcrumbs.

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

    When to use this stack

    • Product setup guides with step-by-step instructions
    • Onboarding checklists for new customers
    • Technical setup articles with FAQs and troubleshooting
    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
    • name
    • step[].text
    • url

    Recommended properties

    • about.@id
    • dateModified
    • description
    • inLanguage
    • itemListElement[].item
    • mainEntity[].acceptedAnswer.text
    • mainEntity[].author.name
    • mainEntity[].name
    • supply
    • tool
    • totalTime
    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": "HowTo",
    "@id": "https://www.example.com/setup/getting-started#howto",
    "name": "Getting Started Setup",
    "description": "Complete these steps to configure your account.",
    "totalTime": "PT30M",
    "step": [
      {
        "@type": "HowToStep",
        "name": "Create your account",
        "text": "Sign up with your work email and verify your address."
      },
      {
        "@type": "HowToStep",
        "name": "Connect your data source",
        "text": "Link your CRM or upload a CSV to import contacts."
      },
      {
        "@type": "HowToStep",
        "name": "Invite teammates",
        "text": "Add team members and assign roles to start collaborating."
      }
    ]
  },
  {
    "@context": "https://schema.org",
    "@type": "TechArticle",
    "@id": "https://www.example.com/setup/getting-started#article",
    "headline": "Getting Started Guide",
    "description": "Learn how to set up your account and configure core features.",
    "datePublished": "2025-05-27",
    "dateModified": "2025-05-27",
    "url": "https://www.example.com/setup/getting-started",
    "author": { "@type": "Organization", "name": "Northwind Docs" }
  },
  {
    "@context": "https://schema.org",
    "@type": "FAQPage",
    "mainEntity": [
      {
        "@type": "Question",
        "name": "Do I need admin access?",
        "acceptedAnswer": {
          "@type": "Answer",
          "text": "Yes. Admin access is required to connect data sources."
        }
      },
      {
        "@type": "Question",
        "name": "How long does setup take?",
        "acceptedAnswer": {
          "@type": "Answer",
          "text": "Most teams finish setup in under 30 minutes."
        }
      },
      {
        "@type": "Question",
        "name": "Can I get help during setup?",
        "acceptedAnswer": {
          "@type": "Answer",
          "text": "Yes. Contact support or join office hours for live help."
        }
      }
    ]
  },
  {
    "@context": "https://schema.org",
    "@type": "BreadcrumbList",
    "itemListElement": [
      { "@type": "ListItem", "position": 1, "name": "Home", "item": "https://www.example.com" },
      { "@type": "ListItem", "position": 2, "name": "Setup", "item": "https://www.example.com/setup" },
      { "@type": "ListItem", "position": 3, "name": "Getting Started", "item": "https://www.example.com/setup/getting-started" }
    ]
  }
]
    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

    Should I include prerequisites?

    Yes. If prerequisites are listed, include them in the HowTo description and FAQ answers.

    How do I show multiple guides?

    Create separate pages per guide and keep JSON-LD aligned to each page's steps.

    Primary sources

    References