Using a style guide for your documents and tutorials keeps your content consistent and easier for your users to follow. When you manually check your content against a style guide, you might catch some issues but miss others. This tutorial shows you how to give Claude a style guide so its feedback is grounded in actual rules, not general writing preferences. You index the HashiCorp style guide into Grounded Docs, a local documentation indexer, and install two skills that know how to run checks against it. Then you run a check on a document with intentional violations and have Claude identify every violation, explain the rule it breaks, and suggest a fix.Documentation Index
Fetch the complete documentation index at: https://cj-teaches.dev/llms.txt
Use this file to discover all available pages before exploring further.
When to use each skill
In this tutorial, you will install two skills. The following is a quick reference for when to use each one:| Skill | When to use |
|---|---|
/quick-style-guide | Fast pass while writing content. Catches common violations in seconds. |
/full-style-guide | In-depth review. Takes longer and uses more tokens. |
Prerequisites
Before starting, complete the following setup:Set up Grounded Docs
Grounded Docs must be installed and the Claude skills must be in place.
Set up the tutorial file
Create a working directory
In your terminal, create a directory for this tutorial and download the demo document:Open
test-style-guide.md in your editor to skim the seeded violations before you let Claude check it.Index the style guides
The HashiCorp style guide ships in two forms: a full reference with detailed rationale and examples, and a machine-optimized quick reference with rules tagged by priority and fix type. You index both so you can use whichever is appropriate for the task. The quick reference is best for fast checks, and is cheaper for Claude to run. The full guide is for in-depth reviews, takes longer, and costs more than the quick guide.Index both style guide versions
Run the following command to index both documents:Claude crawls both URLs and stores the content locally. The quick reference indexes in seconds. The full guide takes slightly longer.
Install the skills
Skills teach Claude how to use indexed documentation. You install one skill for quick checks and one for in-depth reviews. Claude will ask permission to download the files and write to~/.claude/skills/. Approve both prompts.
This tutorial demonstrates the quick check. You install both skills so the full-style-guide is ready when you need an in-depth review.
Run the quick style guide
To check a document, run/quick-style-guide <filename>. Claude searches the indexed style guide for applicable rules, scans your document line by line, and returns findings grouped by severity — each with the line number, the rule it violates, and a suggested fix. Every finding traces back to a specific rule in the indexed style guide.
With the index and skills in place, you run the quick check against a document that contains intentional violations. The file test-style-guide.md contains seeded violations across all different severity levels.
Run the quick style check
Ask Claude to check the test document:Claude searches the Notice that each finding includes the line number, the rule it violates, and a suggested fix. You can trace every finding back to a specific rule in the indexed style guide.
quick-style-guide index for the relevant rules, scans the document, and returns findings grouped by severity.Review the auto-fixable summary
At the end of the report, Claude lists all auto-fixable violations and asks if you want to apply the fixes.
Next steps
In this tutorial, you learned how to index a style guide into Grounded Docs, install skills that know how to use it, and run a check against a document with seeded violations.- Learn how to fact-check your content against versioned documentation.