doc-style-lint

Review documentation against Microsoft and Google style guides for clarity and inclusive language.

Updated Sep 10, 2026
One-click install
npx skills add https://github.com/serpro-workshop-fortaleza/datacorp-sifap-modernization-team-kit --skill doc-style-lint-serpro-workshop-fortaleza
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-style-lint
Source: https://github.com/serpro-workshop-fortaleza/datacorp-sifap-modernization-team-kit/tree/main/.github/skills/doc-style-lint
Command: npx skills add https://github.com/serpro-workshop-fortaleza/datacorp-sifap-modernization-team-kit --skill doc-style-lint-serpro-workshop-fortaleza

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation often drifts away from style guide standards, accumulating passive voice, jargon, exclusionary terms, and untested code examples that confuse readers. This Skill provides a structured review process that catches these issues systematically before publication. ## Core Features & Use Cases - Style Rule Enforcement: Applies concrete rules for voice, tone, sentence length, headings, hyperlinks, code examples, and number formatting based on Microsoft and Google style guides. - Inclusive Language Detection: Flags terms like master/slave, whitelist/blacklist, and gendered language, suggesting approved replacements. - Structured Review Output: Produces a standardized report with readability metrics, issue counts, and a prioritized recommendations table. - Use Case: Before merging a new README or API guide, run this review to verify it passes Vale and markdownlint checks, uses active voice, contains no exclusionary terms, and has tested code examples. ## Quick Start Review the attached README.md against our documentation style guide and report any clarity or inclusive language issues.

Frequently Asked Questions about doc-style-lint

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review documentation against the Microsoft style guide?▼

Run configured automated checkers like Vale first, then apply style rules section by section: active voice, present tense, sentence case headings, and numerals for 10 or more. Finish by testing code examples and verifying hyperlinks.

What tools check documentation for inclusive language?▼

Alex.js and Vale detect exclusionary terms such as master/slave, whitelist/blacklist, and gendered words. The review replaces them with alternatives like primary/replica, allowlist/denylist, and team.

Can I use Vale and markdownlint together in CI?▼

Yes, Vale checks prose style while markdownlint validates Markdown structure, and both run in continuous integration. The review process reports missing tools without installing them automatically.

What are common documentation style mistakes to avoid?▼

Common issues include passive voice, future tense, minimizing words like just and simply, em dashes, click here link text, and untested code snippets. Limit sentences to 25 words and paragraphs to five sentences.

When should style review not override content accuracy?▼

Style should never take priority over technical correctness. Avoid rewriting the author's voice entirely; refine it instead, and preserve accessibility elements like alt text and heading levels.