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

      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

      When to use this stack

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

      What's included

      • Captures the primary step-by-step migration process.

      • Tech Article
        Open generator

        Provides technical context, prerequisites, and deeper explanations.

      • Frequently Asked Questions
        Open generator

        Answers migration timing, rollback, and support questions.

      • Breadcrumb
        Open generator

        Provides navigation context to the migration 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`).

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

      Recommended properties (stack union)

      author.name
      dateModified
      description
      itemListElement[].item
      mainEntity[].acceptedAnswer.text
      mainEntity[].author.name
      mainEntity[].name
      proficiencyLevel
      supply[0].name
      tool[0].name
      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/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" }
          ]
        }
      ]

      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

      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.

      References