seo-optimize

Optimize SEO signals in HashiCorp documentation by improving metadata, headings, and links.

78|252|Updated Feb 7, 2024
One-click install
npx skills add https://github.com/hashicorp/web-unified-docs --skill seo-optimize
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: seo-optimize
Source: https://github.com/hashicorp/web-unified-docs/tree/main/content/well-architected-framework/docs/.claude/skills/seo-optimize
Command: npx skills add https://github.com/hashicorp/web-unified-docs --skill seo-optimize

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

SEO optimization for documentation to improve visibility in search engines and AI/LLM retrieval, ensuring discoverability and clarity.

Core Features & Use Cases

  • Meta Description & Title Optimization: craft concise, keyword-rich meta descriptions and page titles.
  • Heading & Structure Enhancement: improve heading hierarchy and keyword placement for readability and AI retrieval.
  • Link Description Improvements: replace generic link text with descriptive, keyword-rich anchors.
  • Use Case: Before publishing a HashiCorp doc page, run this skill to align SEO signals with content intent and improve indexation.

Quick Start

Use the seo-optimize skill to evaluate and enhance a sample docs/file.mdx or docs/section/*.mdx.

Frequently Asked Questions about seo-optimize

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I optimize documentation SEO before publishing a page?

You optimize documentation SEO by analyzing and improving meta descriptions, titles, headings, and link text to align with content intent. This ensures discoverability and clarity for both search engines and AI retrieval prior to page publication.

What is the best way to improve heading hierarchy and meta descriptions for MDX files?

Improving heading hierarchy and meta descriptions for MDX files involves refining heading structure and keyword placement. This enhances readability and AI retrieval, replacing generic text with keyword-rich anchors and concise summaries.

Does internal linking affect documentation visibility in search engines and LLMs?

Internal linking directly affects documentation visibility by replacing generic link text with descriptive, keyword-rich anchors. This optimization clarifies content intent for search engines and improves LLM retrieval accuracy.

How do I run a pre-release SEO check for HashiCorp documentation?

Pre-release SEO checks for HashiCorp documentation involve evaluating meta descriptions, titles, headings, and link text across repositories. This structured optimization ensures content satisfies indexation and AI-ready criteria before release.

Why do I need to replace generic link text for better documentation indexation?

Replacing generic link text improves documentation indexation by providing descriptive, keyword-rich anchors that clarify context. This optimization aligns SEO signals with content intent, boosting discoverability across search engines and AI models.

Can I use this SEO optimization for documentation updates across multiple repositories?

You can apply SEO optimization to documentation updates across multiple repositories. It analyzes and enhances meta descriptions, titles, headings, and links to maintain consistent SEO visibility and AI retrieval quality.