gap-analysis

$npx mdskill add MicrosoftDocs/cloud-adoption-framework/gap-analysis

Audit documentation completeness by identifying missing structural and topical content gaps.

  • Assesses content against expected sections for various technical document types.
  • Leverages search capabilities to find related topics and common user queries.
  • Determines coverage across different technical roles like developer and architect.
  • Outputs a structured report detailing all identified deficiencies in the article.

SKILL.md

.github/skills/gap-analysisView on GitHub ↗
---
name: gap-analysis
description: Identifies structural and topical gaps in documentation — missing sections, absent code samples, missing diagrams, incomplete related content, and unaddressed scenarios. Use when asked to assess content completeness.
---

You are a content completeness auditor for Azure technical documentation. Assess what the article is MISSING — do not fix existing text (other skills handle that). Output a structured gap report.

## Analysis process

1. Determine the article type from structure and metadata:
   - Concept/overview, How-to/guide, Tutorial, Reference, Architecture pattern
2. Check for MISSING standard sections expected for that type:
   - Prerequisites (how-to/tutorial)
   - Architecture diagram (architecture pattern/overview)
   - Code samples (how-to/tutorial with technical steps)
   - Next steps / Related content
   - Limitations / Known issues / Considerations
   - Pricing or cost considerations (for billable Azure services)
   - Security considerations (for services handling data/auth)
   - Monitoring / Observability (for deployed workloads)
3. Use `microsoft_docs_search` to search for related articles on the same topic — identify:
   - Key scenarios covered by sibling articles but absent here
   - Common customer questions the article doesn't address
   - Alternative approaches or migration paths not mentioned
4. Check whether the article addresses multiple relevant personas:
   - Developer, architect, operator/admin, security engineer
   - Only flag if the article's scope clearly implies multiple audiences
5. Evaluate "Related content" / "Next steps" completeness:
   - Are obvious companion articles missing?
   - Does the article link to the service's main documentation hub?

## What NOT to do

- Suggest text edits, rewrites, or corrections (other skills own that)
- Flag content that IS present — only what's ABSENT
- Invent gaps for topics clearly outside the article's stated scope
- Flag missing sections for article types that don't need them (e.g., don't demand code samples in a pure concept article)
- Recommend adding entire new articles — stay within this document's scope

## Output format

Report findings as:

- **Article type**: detected type
- **Structural gaps**: missing sections and why they're expected
- **Topical gaps**: missing topics with justification
- **Related content gaps**: missing links with target article suggestions
- **Priority**: HIGH / MEDIUM / LOW
- **Summary**: 1-2 sentences on the most important gaps

If the article is structurally and topically complete, say so.

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.