SwiftSchemaGenerate
    Schema stack

    SaaS Migration Guide Stack

    Migration guides for SaaS products with HowTo steps, supporting TechArticle detail, FAQs, and breadcrumb navigation.

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

    When to use this stack

    • Product migration/upgrade guides
    • Switching guides between plans or products
    • Docs where FAQs clarify timelines, downtime, and prerequisites
    Composition

    What is included

    • How To

      Captures the primary step-by-step migration process.

    • Tech Article

      Provides technical context, prerequisites, and deeper explanations.

    • Frequently Asked Questions

      Answers migration timing, rollback, and support questions.

    • Breadcrumb

      Provides navigation context to the migration guide.

    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

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

    Recommended properties

    • author.name
    • dateModified
    • description
    • itemListElement[].item
    • mainEntity[].acceptedAnswer.text
    • mainEntity[].author.name
    • mainEntity[].name
    • proficiencyLevel
    • supply[0].name
    • tool[0].name
    • 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/migrate-to-v2#howto",
    "name": "Migrate from v1 to v2",
    "description": "Step-by-step guide to migrate from the legacy app to v2 with zero downtime.",
    "totalTime": "PT2H",
    "tool": [
      { "@type": "HowToTool", "name": "CLI v2" }
    ],
    "supply": [
      { "@type": "HowToSupply", "name": "API credentials" }
    ],
    "step": [
      {
        "@type": "HowToStep",
        "name": "Back up data",
        "text": "Export your data from v1 using the backup CLI command and store it securely."
      },
      {
        "@type": "HowToStep",
        "name": "Install v2 CLI",
        "text": "Download and install the v2 CLI. Verify with cli --version."
      },
      {
        "@type": "HowToStep",
        "name": "Run migration",
        "text": "Execute the migration script with your API key. Monitor logs for errors."
      }
    ]
  },
  {
    "@context": "https://schema.org",
    "@type": "TechArticle",
    "@id": "https://www.example.com/migrate-to-v2#article",
    "headline": "Migration Guide: v1 to v2",
    "description": "Technical migration notes, prerequisites, and rollback steps for moving to v2.",
    "url": "https://www.example.com/migrate-to-v2",
    "dateModified": "2025-03-15",
    "proficiencyLevel": "Intermediate",
    "author": {
      "@type": "Person",
      "name": "Alex Kim"
    }
  },
  {
    "@context": "https://schema.org",
    "@type": "FAQPage",
    "mainEntity": [
      {
        "@type": "Question",
        "name": "Will there be downtime?",
        "acceptedAnswer": {
          "@type": "Answer",
          "text": "Zero-downtime is supported when you run the migration with blue/green cutover as shown in the guide."
        }
      },
      {
        "@type": "Question",
        "name": "How do I roll back?",
        "acceptedAnswer": {
          "@type": "Answer",
          "text": "Restore from your v1 backup and switch traffic back. Keep DNS TTL low during migration."
        }
      },
      {
        "@type": "Question",
        "name": "Where do I get help?",
        "acceptedAnswer": {
          "@type": "Answer",
          "text": "Use the support form or live chat linked on this page. Include your migration logs for faster assistance."
        }
      }
    ]
  },
  {
    "@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": "Migration", "item": "https://www.example.com/migrate-to-v2" }
    ]
  }
]
    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

    Can I add code samples?

    Yes. Keep them in the page body; the TechArticle object can link to the same URL as the guide.

    Do I need both HowTo and TechArticle?

    Yes. HowTo captures the steps; TechArticle provides supporting technical context and authority signals.

    Primary sources

    References