Documentation Tutorial Stack
Docs tutorials with HowTo + TechArticle context, FAQs, and breadcrumb navigation.
When to use this stack
- Step-by-step developer tutorials and walkthroughs
- Documentation pages with sequential setup tasks
- Pages where FAQs clarify prerequisites and troubleshooting
What is included
Structures the tutorial into clear steps and outcomes.
Provides technical documentation context for the tutorial.
Answers prerequisites, environment, and troubleshooting questions.
Provides navigation context for the tutorial page.
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
Combined JSON-LD
Paste this as one script tag, then replace every example value with data from the live page.
[
{
"@context": "https://schema.org",
"@type": "HowTo",
"@id": "https://www.example.com/docs/tutorials/api-quickstart#howto",
"name": "API Quickstart Tutorial",
"description": "Send your first API request and verify the response.",
"totalTime": "PT20M",
"step": [
{
"@type": "HowToStep",
"name": "Create an API key",
"text": "Generate an API key in the dashboard and copy it to your clipboard."
},
{
"@type": "HowToStep",
"name": "Send a test request",
"text": "Use curl to call the /health endpoint with your API key header."
},
{
"@type": "HowToStep",
"name": "Verify the response",
"text": "Confirm the response status is 200 and the JSON payload includes a success field."
}
]
},
{
"@context": "https://schema.org",
"@type": "TechArticle",
"@id": "https://www.example.com/docs/tutorials/api-quickstart#article",
"headline": "API Quickstart Tutorial",
"description": "Learn how to authenticate and make your first API call in minutes.",
"datePublished": "2025-05-04",
"dateModified": "2025-05-04",
"url": "https://www.example.com/docs/tutorials/api-quickstart",
"author": { "@type": "Organization", "name": "Example Docs" }
},
{
"@context": "https://schema.org",
"@type": "FAQPage",
"mainEntity": [
{
"@type": "Question",
"name": "Do I need a paid plan to use the API?",
"acceptedAnswer": {
"@type": "Answer",
"text": "No. You can start with the free tier; paid plans unlock higher rate limits."
}
},
{
"@type": "Question",
"name": "Which environments are supported?",
"acceptedAnswer": {
"@type": "Answer",
"text": "The quickstart uses curl, but you can follow the same steps in Node, Python, or Go."
}
},
{
"@type": "Question",
"name": "Where can I get help if my request fails?",
"acceptedAnswer": {
"@type": "Answer",
"text": "Check the troubleshooting section and contact support with your request ID."
}
}
]
},
{
"@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": "Tutorials", "item": "https://www.example.com/docs/tutorials" },
{ "@type": "ListItem", "position": 4, "name": "API Quickstart", "item": "https://www.example.com/docs/tutorials/api-quickstart" }
]
}
]Implement and verify
- 01
Start with the live page
Confirm titles, prices, availability, policies, and visible FAQ content before generating markup.
- 02
Add one JSON-LD script
Use the combined example as a template in the document head or before the closing body tag.
- 03
Complete regional details
Fill shipping destinations and timing for every region the page actually serves.
- 04
Link the return policy
Use a stable MerchantReturnPolicy URL and keep its terms synchronized with the page.
- 05
Match visible answers
Add only FAQs that users can read on the same page, with identical answers.
- 06
Validate after changes
Run Rich Results Test after implementation and whenever price, availability, or policy data changes.
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.
Stack FAQs
Should I include code snippets in the HowTo?
Keep code snippets on the page; the HowTo steps can reference them but should stay concise.
How do I handle multiple languages?
Create separate tutorial pages per language and keep each page's HowTo steps aligned to that language's examples.