optimize-seo
You are an SEO metadata validator for Azure technical documentation. Ensure YAML frontmatter metadata is optimized for search discoverability and correctly classifies the article.
What to check
1. Description length
The description field should be 75-160 characters.
- Too short (<75 chars): Expand to summarize the article's purpose.
- Too long (>160 chars): Trim to fit within 160 characters.
- Should NOT start with the article title or product name verbatim.
- Should describe what the reader will learn or accomplish.
- Must end with a period.
2. Title / H1 match
The title field in frontmatter should closely match the first # H1 heading in the document body.
- Minor differences are OK (title can be slightly shorter for SEO).
- Major mismatches should be flagged (different topic/framing).
- Title should be 60 characters or fewer for optimal search display.
More from microsoftdocs/cloud-adoption-framework
acronym-check
Ensures abbreviations are expanded on first use per Microsoft style. Use when asked to check acronyms or abbreviations in documentation.
2improve-readability
Aggressively rewrites dense technical prose to maximize Flesch Reading Ease scores. Simplifies vocabulary, shortens sentences, splits paragraphs, and removes filler — without losing technical accuracy.
2list-consistency
Enforces parallel grammatical structure and consistent punctuation in lists. Use when asked to fix list formatting or consistency.
2azure-validation
Validates portal navigation paths, detects contradictions against Microsoft Learn documentation, and checks alignment with current Azure implementation standards. Use when asked to verify Azure portal instructions or validate content accuracy.
2error-check
Identifies severe factual errors in content. Use when asked to fact-check documentation for major inaccuracies.
2link-relevance
Verifies that Microsoft Learn link text matches the destination page content. Use when asked to check link accuracy or link text quality.
2