Provider Docs

Keeps your Terraform provider documentation in sync with your code using HashiCorp's tfplugindocs tooling and recommended patterns. You'll use this when adding resources, data sources, functions, or guides, or when you need to troubleshoot why docs aren't showing up correctly in the Registry. It walks you through the full cycle: write schema descriptions first, create templates in the right places, generate the markdown, validate it matches your actual implementation, then publish with proper semantic versioning. The quality bar is tight: examples must be runnable, terminology stays consistent, and you never document arguments that don't exist. If you maintain a provider, this keeps you from shipping stale or wrong docs.

skills.sh installs: 3.3K
GitHub stars: 924
last updated: Aug 21, 2026

View on GitHub

Install

$ npx -y skills add hashicorp/agent-skills --skill provider-docs --agent claude-code

Installs into .claude/skills of the current project.

Files

Terraform Provider Docs

Follow This Workflow

Confirm scope and documentation targets.

Map code changes to the exact doc targets: provider index, resources, data sources, ephemeral resources, list resources, functions, actions, or guides.
Decide whether content should come from schema descriptions, templates, or both.

Write schema descriptions first.

Add precise user-facing descriptions to schema fields so generated docs stay aligned with behavior.
Keep wording specific to argument purpose, constraints, defaults, and computed behavior.

SKILL.md on GitHub

Sponsors

Promote your product hereReach 125k+ visitors monthly Promote your product hereReach 125k+ visitors monthly