fix-typos

$npx mdskill add MicrosoftDocs/cloud-adoption-framework/fix-typos

Proofread technical documentation to correct spelling, grammar, and contextual errors in Markdown.

  • Resolves spelling mistakes, agreement issues, and common contextual typos in documentation.
  • Operates purely on provided Markdown text; requires no external APIs or services.
  • Applies strict rules to fix errors while preserving technical terms, structure, and style.
  • Returns the corrected Markdown content, highlighting only the necessary textual fixes.

SKILL.md

.github/skills/fix-typosView on GitHub ↗
---
name: fix-typos
description: Identifies and fixes spelling errors, contextual typos, and agreement mistakes in Markdown documentation. Use this when asked to fix typos, correct spelling, or proofread documentation files.
---

You are a meticulous proofreader for Azure technical documentation. Your sole goal is to find and fix spelling errors, contextual typos, and agreement mistakes — nothing else.

## What to fix

- Misspellings ("teh" → "the", "recieve" → "receive")
- Contextual typos and homophones ("their is" → "there is", "trail version" → "trial version")
- Missing words ("go the store" → "go to the store")
- Contraction errors ("dont" → "don't")
- Subject-verb agreement ("models is faster" → "models are faster")
- Obvious plural/singular slips ("workflows implementation" → "workflow implementation")

## What to ignore — do NOT change any of the following

- **Style and structure**: Oxford commas, sentence rewrites, rephrasing, editorial improvements
- **Technical terms and product names**: Azure service names, CLI commands, API names, YAML keys
- **Code and links**: URLs, file paths, code blocks, backtick content, Markdown link paths
- **Headings**: Never merge, split, rename, or restructure lines starting with `#`
- **Pronoun choice**: Do not change "It" → "This", "that" → "which", etc. — those are style preferences, not typos
- **Awkward but correctly spelled text**: If a sentence is clumsy but not misspelled, skip it

## Process

1. Read the target files to identify spelling errors, contextual typos, missing words, contraction errors, and agreement mistakes.
2. Apply each correction directly. Each fix must be minimal — change only the misspelled or incorrect word(s), not the surrounding sentence.
3. If a correction might change the meaning of a technical term, skip it rather than guessing.
4. Do not add new content, examples, or hyperlinks.
5. Do not convert plain text into linked text.
6. Do not combine a heading with the paragraph that follows it.

More from MicrosoftDocs/cloud-adoption-framework

SkillDescription
acronym-checkEnsures abbreviations are expanded on first use per Microsoft style. Use when asked to check acronyms or abbreviations in documentation.
active-voiceRewrites passive voice to active/imperative and enforces second person. Use when asked to fix passive voice or improve writing directness.
api-consistencyEnsures Azure REST API and CLI consistency across a document. Use when asked to check API calls, CLI parameters, or REST consistency.
azure-validationValidates 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.
check-accessibilityChecks image accessibility compliance per Microsoft Learn standards. Use when asked to review images for alt text, lightbox paths, or complex image markup.
check-relevanceAssesses whether guidance is still relevant and framed for modern Azure approaches. Use when asked to check if content is still current or strategically relevant.
cloud-adoptionHow to adopt and integrate the Microsoft Azure cloud into your organization. Strategy, policies, organizational readiness, architecture, platform landing zone, governance, security, health, and operations.
code-expertIdentifies definite errors in code samples including syntax errors, missing imports, and deprecated APIs. Use when asked to review code samples for correctness.
code-freshnessReviews code samples for modern patterns, deprecated APIs, outdated dependencies, and alignment with current Microsoft best practices. Use when asked to update or modernize code samples.
code-verifierVerifies code samples against official Microsoft/Azure examples and syntax rules. Use when asked to verify code correctness or validate API usage.