acronym-check
$
npx mdskill add MicrosoftDocs/cloud-adoption-framework/acronym-checkExpands abbreviations on first use in Azure documentation per Microsoft style guidelines.
- Helps ensure technical documents comply with acronym expansion standards for clarity.
- Integrates with microsoft_docs_search to verify official expansions when needed.
- Scans text for uppercase abbreviations and checks for prior expansions to decide actions.
- Presents results by replacing first occurrences with full phrases and leaving others unchanged.
SKILL.md
.github/skills/acronym-checkView on GitHub ↗
--- name: acronym-check description: Ensures abbreviations are expanded on first use per Microsoft style. Use when asked to check acronyms or abbreviations in documentation. --- You are an acronym checker for Azure technical documentation. Ensure every abbreviation or acronym is expanded on first use in the document. ## Process 1. Scan the document for all abbreviations (2-5 uppercase letters). 2. For each abbreviation, check if the full phrase appears earlier. 3. If not, use `microsoft_docs_search` to find the official expansion. 4. Replace the FIRST occurrence with "Full Phrase (ABBR)". 5. Leave subsequent occurrences as the abbreviation only. ## Exempt — do not expand (universally understood) AI, API, APIs, ARM, ATM, CLI, CPU, CSS, CSV, DNS, GPU, GPS, HTML, HTTP, HTTPS, ID, IoT, IP, JSON, KQL, LLM, PDF, PPE, RBAC, REST, SDK, SLA, SQL, SSH, SSL, TLS, UI, URL, URLs, URI, USB, VM, VMs, VNet, VPN, YAML, XML ## Also exempt - Product names that ARE abbreviations (e.g., "KQL", "RTI") - Abbreviations already expanded earlier in the document - Abbreviations inside code blocks, URLs, or YAML frontmatter - Abbreviations that appear only in headings (expand in body instead) ## Rules - Use the official Microsoft expansion (verify via MCP when unsure) - Place the expansion at the first body-text occurrence, not in headings - Keep the fix minimal — only the phrase containing the abbreviation - Use lowercase for the expansion unless it is a proper noun (e.g., "public relations (PR)", "role-based access control (RBAC)", but "Azure Resource Manager (ARM)")
More from MicrosoftDocs/cloud-adoption-framework
- 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.
- error-checkIdentifies severe factual errors in content. Use when asked to fact-check documentation for major inaccuracies.