check-hashicorp-style

Name: check-hashicorp-style
Availability: InStock
Author: HashiCorp

Validate HashiCorp documentation against the official style guide.

78|252|Updated Feb 7, 2024

Search Tags:#linting #documentation #formatting #style-guide #active-voice #present-tense #word-choice

Ready to run

npx skills add https://github.com/hashicorp/web-unified-docs --skill check-hashicorp-style

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: check-hashicorp-style
Source: https://github.com/hashicorp/web-unified-docs/tree/main/content/well-architected-framework/docs/.claude/skills/check-hashicorp-style
Command: npx skills add https://github.com/hashicorp/web-unified-docs --skill check-hashicorp-style

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill validates documentation against the HashiCorp official style guide to improve clarity, consistency, and readability.

Core Features & Use Cases

Checks for active voice, present tense, and precise word choice.
Ensures formatting consistency and alignment with the official guide.
Use case: run during review to catch style regressions before publication.

Quick Start

Use the /check-hashicorp-style command on your docs to identify and fix style issues.

Frequently Asked Questions about check-hashicorp-style

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

FAQPage Schema

How do I check HashiCorp documentation for active voice and present tense?▼

You can validate HashiCorp documentation by running the /check-hashicorp-style command to detect active voice, present tense, and word-choice compliance issues in your Markdown or MDX content.

What is the best way to enforce a style guide on Markdown docs before publication?▼

The best way to enforce a style guide is to lint documentation during the review phase to catch style regressions and fix formatting, voice, and terminology issues before publication.

Can I automatically fix style and formatting issues in MDX content?▼

Yes, you can automatically fix common style and formatting issues in MDX content using the optional auto-fix capabilities provided by the documentation style linter.

Does the HashiCorp style linter work with Markdown and MDX files?▼

Yes, the HashiCorp style linter works with Markdown and MDX files, validating content against official style rules to ensure consistent terminology and formatting.

What style guide rules are checked during documentation formatting validation?▼

Documentation formatting validation checks for active voice, simple present tense, precise word choice, consistent terminology, and formatting rules defined in the official styleguide.md.

When should I run a documentation style check during the authoring process?▼

You should run a documentation style check during authoring, drafting, or pre-publication reviews to catch and fix style regressions before publishing your content.