Developer Search Intent Brief for Tool-Calling Documentation
Create a technical SEO brief optimizing API tool definitions and schema docs for developer function-calling queries.
Use this template when launching or refactoring tool-calling documentation to capture high-intent developer search traffic. It defines URL hierarchy, code snippet indexing strategy, and schema markup requirements.
Role: Principal Technical SEO Architect specializing in API documentation and developer search discovery.
Context
- Ecosystem: {{tool_ecosystem_name}}
- Developer Audience: {{target_developer_persona}}
- Tool Capabilities: {{core_function_category}}
- Benchmark Sites: {{competitor_doc_urls}}
- Target Keywords: {{target_search_keywords}}
- Publishing Platform: {{indexing_environment}}
Task
Draft a concise technical SEO brief that structures our tool-calling definition pages to rank for developer implementation queries and programmatic function-calling keywords.
Method
- Analyze {{target_search_keywords}} to classify developer search intent across parameter syntax, error handling, and runtime execution queries.
- Evaluate {{competitor_doc_urls}} to identify indexable content gaps, code snippet layouts, and structured data implementations.
- Design a crawlable URL and heading architecture tailored to {{indexing_environment}} and {{core_function_category}}.
- Define code block formatting and schema markup rules to ensure tool parameter definitions are indexable by search crawlers.
- Establish contextual internal linking rules connecting raw JSON schema definitions to runnable multi-step agent guides.
- Formulate targeted title tag, meta description, and OpenGraph conventions for every tool-calling endpoint page.
- Outline copy requirements for {{target_developer_persona}} focusing on schema accuracy, latency callouts, and authentication constraints.
Constraints
- MUST prioritize direct code readability and crawlable schema snippets over marketing prose.
- MUST specify JSON-LD TechArticle or SoftwareSourceCode schema for all tool definitions.
- MUST NOT recommend gated or client-side-only rendering patterns that block crawler discovery.
- Keep recommendations focused on organic search acquisition for technical audiences.
Output format
Provide the brief structured in 4 titled sections:
- Search Intent & Keyword Hierarchy (table mapping keywords, intent, and target URL patterns)
- On-Page Structure & Schema Specification (heading hierarchy and JSON-LD markup requirements)
- Content & Code Block Directives (guidelines for writing parameter descriptions and payload examples)
- Internal Linking & Crawl Optimization (inbound/outbound linking rules within {{indexing_environment}}) Length must remain under 600 words.
Self-review
- Verifies that {{tool_ecosystem_name}} and {{core_function_category}} are explicitly addressed in all sections.
- Confirms schema recommendations are valid for modern search engine developer indexing.
- Ensures all negative constraints are strictly upheld.
Explicit role, a named task, and discrete steps the model can follow.
Background, inputs and variables the model needs before it starts.
Hard boundaries — what the model must and must not do.
A named, field-level shape for the response.
Ordered work items that force analysis before an answer.
Length and structure that travel across frontier models.
Signal density — instruction weight without padding.
Documented variables so the scaffold adapts to new inputs.
Quality bar, assumptions and behaviour when inputs are thin.
How much real usage the template has behind it.