check-consistency

Identify terminology, naming, and style inconsistencies across WAF documentation.

78|252|Updated Feb 7, 2024
One-click install
npx skills add https://github.com/hashicorp/web-unified-docs --skill check-consistency
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: check-consistency
Source: https://github.com/hashicorp/web-unified-docs/tree/main/content/well-architected-framework/docs/.claude/skills/check-consistency
Command: npx skills add https://github.com/hashicorp/web-unified-docs --skill check-consistency

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill identifies terminology, naming, and style inconsistencies across WAF documentation, helping maintain a unified voice and professional presentation.

Core Features & Use Cases

  • Terminology consistency checks across documents
  • Product name capitalization and formatting checks
  • Auto-fix suggestions and glossary generation

Quick Start

Run /check-consistency docs/ to scan a directory; use --fix to auto-apply fixes; use --create-glossary to generate a terminology glossary.

Frequently Asked Questions about check-consistency

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

FAQPage Schema
How do I check terminology consistency across a documentation directory?

You can check terminology consistency by scanning a single directory or an entire docs set. The tool flags terminology, naming, and style inconsistencies by category and supports auto-fix for most issues.

Can I automatically fix documentation style and capitalization errors?

Yes, you can automatically fix documentation style and capitalization errors by using the auto-fix feature. It supports auto-applying corrections in most categories, including product names, formatting, and voice, to maintain a unified presentation.

How do I generate a terminology glossary from existing docs?

You generate a terminology glossary from existing docs by running the consistency check with the glossary creation flag. It analyzes your documentation set to extract and compile defined terms into a reference glossary.

What documentation consistency issues does this tool flag?

The tool flags documentation consistency issues across six categories: product names, terminology, capitalization, formatting, headings, and voice. It helps maintain a unified voice and professional presentation across your docs.

Does the documentation consistency check support strict mode?

Yes, the documentation consistency check supports a strict mode for stricter validation. It integrates with other style checks to validate documentation against established style guide rules.

When should I use strict mode for documentation style checks?

Use strict mode for documentation style checks when you need rigorous validation against your style guide. It enforces tighter rules on terminology, capitalization, and formatting, ensuring high compliance for professional documentation.