docs-check-style

Validate documentation content against the Elastic style guide with Vale.

71|10|Updated Aug 20, 2025
One-click install
npx skills add https://github.com/elastic/elastic-docs-skills --skill docs-check-style
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-check-style
Source: https://github.com/elastic/elastic-docs-skills/tree/main/skills/review/docs-check-style
Command: npx skills add https://github.com/elastic/elastic-docs-skills --skill docs-check-style

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the tedious process of checking documentation against the Elastic style guide, ensuring consistency in voice, tone, grammar, formatting, accessibility, and word choice.

Core Features & Use Cases

  • Automated Linting: Utilizes the Vale linter to catch common style violations.
  • Comprehensive Rule Set: Checks against specific Elastic style guidelines for voice, tone, word choice, grammar, spelling, formatting, accessibility, and UI writing.
  • Use Case: Before publishing new documentation, run this Skill to proactively identify and correct any style inconsistencies, saving review time and improving document quality.

Quick Start

Run the docs-check-style skill on the file 'contributing.md'.

Frequently Asked Questions about docs-check-style

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

FAQPage Schema
How do I lint documentation for style guide compliance?

Linting documentation for style guide compliance involves scanning files to detect violations in voice, tone, grammar, formatting, and accessibility, ensuring content meets specific consistency standards before publication.

What does automated documentation style checking cover?

Automated documentation style checking covers voice, tone, word choice, grammar, spelling, formatting, accessibility, and UI writing standards to proactively identify and correct style inconsistencies in your content.

How do I check markdown files against the Elastic style guide?

You can check markdown files against the Elastic style guide by running a Vale-based linting scan on your target file or directory to validate adherence to predefined rules for clarity, consistency, and formatting.

Does documentation linting with Vale check for accessibility?

Yes, documentation linting with Vale checks for accessibility alongside grammar, spelling, and formatting, scanning your files to ensure comprehensive adherence to required style and accessibility standards.

What is the best way to enforce consistent voice and tone in technical documentation?

The best way to enforce consistent voice and tone in technical documentation is to run an automated linter like Vale that scans your files against a predefined style guide to catch and correct deviations before publishing.