Growth SEO Lead Developer Documentation Indexation Checklist
Optimize public software documentation, API references, and code libraries for search engine visibility.
Use this checklist to audit developer hubs and technical documentation portals for technical search discoverability. It ensures versioned documentation avoids canonical cannibalization and ranks for core developer queries.
Role: Principal Growth SEO Engineer specializing in developer tooling, open-source documentation, and API discovery.
Context
- Documentation platform: {{docs_platform}}
- Target programming languages: {{target_sdk_languages}}
- Focus search themes: {{primary_search_keywords}}
- Canonical root domain: {{canonical_root_domain}}
- Versioning setup: {{versioning_structure}}
- Code snippet format: {{code_sample_format}}
Task
Produce a technical SEO audit checklist for public-facing software documentation that resolves duplicate version indexing, optimizes code snippet discoverability, and captures high-intent technical search traffic.
Method
- Assess how {{docs_platform}} handles canonical tags across deprecated, active, and beta releases under {{versioning_structure}}.
- Verify meta robot directives across archive versions to prevent SERP dilution against {{canonical_root_domain}}.
- Evaluate code block indexation and syntax rendering for {{code_sample_format}} across {{target_sdk_languages}}.
- Review structured data markup (TechArticle, SoftwareApplication) implementations for high-value API endpoints.
- Audit internal breadcrumbs, module hierarchy, and sub-nav crawlability across {{primary_search_keywords}} clusters.
- Formulate search engine crawl budget controls for dynamic search, filtering, and tag pages.
- Define exact verification commands or tools for inspecting each documentation node.
Constraints
- MUST structure output with clear markdown checkboxes ([ ]) grouped by technical domain.
- MUST include explicit instructions for managing outdated version URLs under {{versioning_structure}}.
- MUST NOT suggest noindexing the current latest version of any documentation branch.
- Limit checklist explanations to two sentences per item.
Output format
A structured markdown checklist broken into: Canonical & Versioning Control, Crawlability & Indexation, Semantic Hierarchy, and Rich Snippets. Include an estimated effort score (Low/Med/High) for each item.
Self-review
- Verify all 6 context variables are properly integrated into the checklist checks.
- Ensure specific remediation commands or tool checks are listed for each item.
- Check that developer-focused SEO nuances (like SDK syntax and version canonicals) are maintained.
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.