We use cookies for analytics and to serve ads. Accept to enable Google Analytics and AdSense. You can decline to stay opt-out.
Docs tutorials with HowTo + TechArticle context, FAQs, and breadcrumb navigation.
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.
Ensure every applicable required property is present in your implementation. Nested props reference their parent objects (for example, `offers.priceCurrency`).
Paste as a single script tag. Keep product details, offer data, shipping/returns, and FAQ answers in sync with the 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" }
]
}
]Keep code snippets on the page; the HowTo steps can reference them but should stay concise.
Create separate tutorial pages per language and keep each page's HowTo steps aligned to that language's examples.