docs-check-style

Official

Ensure Elastic style guide compliance.

Authorelastic
Version1.0.0
Installs0

System Documentation

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'.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: docs-check-style
Download link: https://github.com/elastic/elastic-docs-skills/archive/main.zip#docs-check-style

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.