Cookies & analytics

    We use cookies for analytics and to serve ads. Accept to enable Google Analytics and AdSense. You can decline to stay opt-out.

    SwiftSchema Logo

    SwiftSchema

    Intuitive Schema Generation at Your Fingertips

    AboutLearnContact
      Stack

      Onboarding / Setup Guide Stack

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

      Open generatorValidate in Rich Results Test

      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

      What's included

      • Structures the setup guide into clear steps.

      • Tech Article
        Open generator

        Provides the technical article context for the guide.

      • Frequently Asked Questions
        Open generator

        Answers setup, troubleshooting, and access questions.

      • Breadcrumb
        Open generator

        Provides navigation context for the guide.

      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
      name
      step[].text
      url

      Recommended properties (stack union)

      about.@id
      dateModified
      description
      inLanguage
      itemListElement[].item
      mainEntity[].acceptedAnswer.text
      mainEntity[].author.name
      mainEntity[].name
      supply
      tool
      totalTime

      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": "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" }
          ]
        }
      ]

      Implementation steps

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

      Common errors and fixes

      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.

      References