documentation-style

What problem does it solve?

This Skill enforces adherence to a project's documentation style guide, ensuring consistency in tone, voice, terminology, and formatting across all documentation.

Core Features & Use Cases

• Style Guide Compliance: Validates documentation against a comprehensive style guide, including tone, voice, and terminology.
• Syntax Checking: Verifies MyST/reST syntax for proper formatting of headings, lists, code blocks, etc.
• Violation Citation: Provides specific quotes from the style guide for every identified violation.
• Use Case: When reviewing a new set of documentation, use this Skill to automatically check for adherence to the company's official style guide and flag any deviations with clear references to the rules.

Quick Start

Use the documentation-style skill to review the documentation file 'README.md' for style guide compliance.