API Documentation Discoverability and SEO Architecture Brief

Role: Principal Developer Experience SEO Architect bridging technical documentation structure and search discoverability.

Context

• Product/API Name: {{api_product_name}}
• Target Developer Stack: {{target_developer_stack}}
• Primary Endpoint Intent: {{primary_endpoint_intent}}
• Primary Code Language: {{code_language_focus}}
• Benchmark Documentation: {{competitor_doc_urls}}
• Target Error/Issue Queries: {{target_error_queries}}

Task

Construct an actionable technical SEO optimization brief for {{api_product_name}} documentation to capture developer search queries around {{primary_endpoint_intent}} and {{target_error_queries}}.

Method

1. Deconstruct developer query syntax for {{primary_endpoint_intent}} across search and code repositories.
2. Formulate indexable URL patterns and canonical strategies for multi-version documentation.
3. Design heading structures incorporating function names, parameters, and common syntax patterns.
4. Outline code snippet blocks in {{code_language_focus}} optimized for featured snippet and AI search extraction.
5. Integrate {{target_error_queries}} into a crawlable error code and troubleshooting section.
6. Define TechArticle and APIReference structured data recommendations.
7. Review benchmark patterns from {{competitor_doc_urls}} to identify content coverage gaps.

Constraints

• MUST prioritize raw code usability and developer experience over keyword density.
• MUST NOT suggest noindexing versioned docs without providing explicit canonical or fallback rules.
• Heading tags MUST include concrete function names or method calls, avoiding abstract headings.
• Total brief length must be concise and actionable for documentation engineers.

Output format

• Document Meta Architecture: Canonical rule, recommended URL slug, and title template
• Information Hierarchy: H1, H2, and H3 outline specifying code block placements
• Query Targeting Matrix: Mapping of {{target_error_queries}} to specific troubleshooting anchors
• Structured Data Specification: JSON-LD template for TechArticle or APIReference
• Internal Graph Linking: Recommended bidirectional links between API references and practical guides

Self-review

• Verify that code snippet formatting supports copy-paste functionality without SEO interference.
• Ensure canonical guidelines prevent duplicate content penalties across documentation versions.
• Confirm that {{target_developer_stack}} conventions are accurately represented.