Structured Data & Schema Markup for AI — Technical writers

{
  "@context": "https://schema.org",
  "@type": "APIReference",
  "name": "[Product Name] Documentation",
  "description": "Comprehensive technical documentation for [Product Name], including API references, guides, and tutorials.",
  "programmingModel": "REST",
  "version": "1.0",
  "provider": {
    "@type": "Organization",
    "name": "[Company Name]"
  }
}

{
  "@context": "https://schema.org",
  "@type": "APIReference",
  "name": "[API Endpoint Name]",
  "description": "Details of the [HTTP Method] [API Endpoint] including parameters, request/response schemas, and example usage.",
  "codeSample": [
    {
      "@type": "CodeSample",
      "lang": "json",
      "sourceCode": "{\"parameter\": \"value\"}"
    }
  ],
  "executableType": "HTTP"
}

{
  "@context": "https://schema.org",
  "@type": "FAQPage",
  "mainEntity": [{
    "@type": "Question",
    "name": "How to resolve [Common Error Code/Issue]?",
    "acceptedAnswer": {
      "@type": "Answer",
      "text": "Your precise, step-by-step solution with code examples and context, designed for AI Answer Engines to surface for specific technical problems."
    }
  }]
}

{
  "@context": "https://schema.org",
  "@type": "BreadcrumbList",
  "itemListElement": [{
    "@type": "ListItem",
    "position": 1,
    "name": "Docs Home",
    "item": "https://docs.example.com/"
  }, {
    "@type": "ListItem",
    "position": 2,
    "name": "API Reference",
    "item": "https://docs.example.com/api"
  }, {
    "@type": "ListItem",
    "position": 3,
    "name": "[API Endpoint Group]",
    "item": "https://docs.example.com/api/users"
  }]
}

{
  "@context": "https://schema.org",
  "@type": "Article",
  "name": "[Guide Title]",
  "aggregateRating": {
    "@type": "AggregateRating",
    "ratingValue": "4.7",
    "ratingCount": "520"
  }
}

{
  "@context": "https://schema.org",
  "@type": "HowTo",
  "name": "How to integrate [Feature/SDK]",
  "step": [{
    "@type": "HowToStep",
    "text": "Step 1: Install the SDK using npm install [package-name]",
    "url": "https://docs.example.com/integration#step1"
  }, {
    "@type": "HowToStep",
    "text": "Step 2: Initialize the client with your API key.",
    "url": "https://docs.example.com/integration#step2"
  }]
}

{
  "@context": "https://schema.org",
  "@type": "Article",
  "author": {
    "@type": "Person",
    "name": "[Expert Author Name]",
    "jobTitle": "Senior Technical Writer at [Company Name]",
    "affiliation": {
      "@type": "Organization",
      "name": "[Company Name]"
    },
    "sameAs": ["[LinkedIn URL]", "[GitHub URL]"]
  },
  "publisher": {
    "@type": "Organization",
    "name": "[Company Name]",
    "logo": {
      "@type": "ImageObject",
      "url": "https://example.com/logo.png"
    }
  }
}

{
  "@context": "https://schema.org",
  "@type": "Dataset",
  "name": "[Language/Framework] Code Snippets for [Feature]",
  "description": "A collection of reusable code examples demonstrating the usage of [Product Feature] in [Language/Framework].",
  "distribution": {
    "@type": "DataDownload",
    "contentUrl": "https://example.com/code/snippets.zip",
    "fileFormat": "zip"
  },
  "publisher": {
    "@type": "Organization",
    "name": "[Company Name]"
  }
}

{
  "@context": "https://schema.org",
  "@type": "Organization",
  "name": "[Company Name]",
  "url": "https://example.com",
  "logo": "https://example.com/logo.png",
  "contactPoint": {
    "@type": "ContactPoint",
    "telephone": "+1-XXX-XXX-XXXX",
    "contactType": "Technical Support"
  },
  "sameAs": [
    "https://twitter.com/companyname",
    "https://linkedin.com/company/companyname",
    "https://github.com/companyname"
  ]
}

{
  "@context": "https://schema.org",
  "@type": "WebPage",
  "speakable": {
    "@type": "SpeakableSpecification",
    "xpath": ["//h2[contains(text(), 'Getting Started')]/following-sibling::p[1]", "//div[@class='api-example']/pre"] 
  }
}