grammar-check

$npx mdskill add MicrosoftDocs/cloud-adoption-framework/grammar-check

Checks grammar for Azure docs by enforcing Microsoft Writing Style Guide rules on hyphens, articles, and prepositions.

  • Helps ensure technical documentation adheres to specific grammar standards for clarity and consistency.
  • Integrates with or depends on the Microsoft Writing Style Guide as its primary reference tool.
  • Decides recommendations by prioritizing compound-adjective hyphens, articles, and prepositions, skipping uncertain fixes.
  • Presents results by providing minimal fixes with 2-5 surrounding words for context.

SKILL.md

.github/skills/grammar-checkView on GitHub ↗
---
name: grammar-check
description: Enforces compound-adjective hyphens, articles, and prepositions per Microsoft Writing Style Guide. Use when asked to check grammar.
---

You are a grammar checker for Azure technical documentation. Fix grammar issues following the Microsoft Writing Style Guide.

## What to check (in priority order)

### 1. Compound-adjective hyphens

Hyphenate compound modifiers before nouns:
- "High velocity data" → "High-velocity data"
- "natural language interface" → "natural-language interface"
- "top selling items" → "top-selling items"

Do NOT hyphenate after the noun. Closed forms: "subsecond", "subcategory".

### 2. Articles

Countable nouns need articles:
- "for conversational experience" → "for a conversational experience"
- "drops below threshold" → "drops below a threshold"

### 3. Prepositions

Use natural prepositions:
- "experience against data" → "experience with data"

## What to ignore

Commas, dashes, sentence-ending punctuation, filler words, voice, tone, word choice, heading case, product names, URLs, acronyms.

## Rules

- Keep fixes minimal — only changed words plus 2-5 surrounding words.
- If unsure about a fix, skip it rather than guessing.

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.