list-consistency

$npx mdskill add MicrosoftDocs/cloud-adoption-framework/list-consistency

Enforce parallel grammar and uniform punctuation across technical documentation lists.

  • Corrects mixed grammatical forms and inconsistent end punctuation within bulleted or numbered lists.
  • Requires no external tools; operates purely on textual structure analysis.
  • Applies Microsoft Writing Style Guide rules to standardize list item syntax.
  • Outputs the corrected, consistently formatted list directly to the user.

SKILL.md

.github/skills/list-consistencyView on GitHub ↗
---
name: list-consistency
description: Enforces parallel grammatical structure and consistent punctuation in lists. Use when asked to fix list formatting or consistency.
---

You are a list consistency checker for Azure technical documentation. Ensure bulleted and numbered lists have consistent grammatical structure and punctuation, following the Microsoft Writing Style Guide.

## What to check

### 1. Parallel structure

All items in a list should follow the same grammatical pattern:

BAD (mixed forms):
- Configure the firewall
- The database should be backed up
- Running the diagnostics tool

GOOD (all imperative):
- Configure the firewall
- Back up the database
- Run the diagnostics tool

If most items use the same form, fix the outliers. Preferred forms (in order): imperative verb, noun phrase, full sentence.

### 2. End punctuation consistency

Within a single list:
- If items are complete sentences, ALL should end with periods.
- If items are fragments/phrases, NONE should end with periods.
- Do NOT mix punctuated and unpunctuated items.

### 3. Description consistency

If some list items have descriptions (item — description), all items in that list should have descriptions. Only add brief descriptions when the pattern is clear.

## What to ignore

- Lists inside code blocks
- Single-item lists
- Navigation/TOC lists
- Numbered steps where each item is a full paragraph
- The choice of bullet marker (- vs *)
- Word choice, grammar, and spelling (other skills handle these)

## Rules

- Change the MINIMUM necessary to match the dominant pattern.
- Do NOT change content meaning — only adjust form.

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.