Provider Docs
- 2k installs
- 781 repo stars
- Updated August 4, 2026
- hashicorp/agent-skills
provider-docs is an agent skill for Create, update, and review Terraform provider documentation for Terraform Registry using HashiCorp-recommended patterns,
About
The provider-docs skill Create, update, and review Terraform provider documentation for Terraform Registry using HashiCorp-recommended patterns, tfplugindocs templates, and schema descriptions. Use when adding or changing provider configuration, resources, data sources, ephemeral resources, list resources, functions, or guides; when validating generated docs; and when troubleshooting missing or incorrect Registry documentation. It covers confirm scope and documentation targets.. Key workflows include map code changes to the exact doc targets: provider index, resources, data sources, ephemeral resources, list resources, functions, or guides.. Developers invoke provider-docs when the task matches the triggers and reference files in SKILL.md for grounded, stepwise execution. Reference files and progressive disclosure keep context focused while preserving concrete commands, configuration fields, and validation checks copied from the upstream documentation. Reference files and progressive disclosure keep context focused while preserving concrete commands, configuration fields, and validation checks copied from the upstream documentation.
- Confirm scope and documentation targets.
- Map code changes to the exact doc targets: provider index, resources, data sources, ephemeral resources, list resources,
- 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.
Provider Docs by the numbers
- 2,049 all-time installs (skills.sh)
- +113 installs in the week ending Aug 5, 2026 (Skillselion tracking)
- Ranked #196 of 1,039 Cloud & Infrastructure skills by installs in the Skillselion catalog
- Security screen: LOW risk (skills.sh audit)
- Data as of Aug 5, 2026 (Skillselion catalog sync)
provider-docs capabilities & compatibility
- Capabilities
- confirm scope and documentation targets. · map code changes to the exact doc targets: provi · decide whether content should come from schema d · write schema descriptions first. · add precise user facing descriptions to schema f
- Use cases
- documentation
What provider-docs says it does
1. Confirm scope and documentation targets.
npx skills add https://github.com/hashicorp/agent-skills --skill provider-docsAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 2k |
|---|---|
| repo stars | ★ 781 |
| Security audit | 3 / 3 scanners passed |
| Last updated | August 4, 2026 |
| Repository | hashicorp/agent-skills ↗ |
What problem does provider-docs solve for developers using the documented workflows?
Create, update, and review Terraform provider documentation for Terraform Registry using HashiCorp-recommended patterns, tfplugindocs templates, and schema descriptions. Use when adding or changing pr
Who is it for?
Developers working with provider-docs patterns described in the skill documentation.
Skip if: Skip when docs are empty or the task is outside the skill documented scope.
When should I use this skill?
Use when Create, update, and review Terraform provider documentation for Terraform Registry using HashiCorp-recommended patterns, tfplugindocs templates, and schema descriptions. Use when a
What you get
Actionable provider-docs guidance grounded in SKILL.md workflows and reference files.
- Registry-ready provider documentation
- Resource and data source reference pages
Files
Terraform Provider Docs
Follow This Workflow
1. Confirm scope and documentation targets.
- Map code changes to the exact doc targets: provider index, resources, data sources, ephemeral resources, list resources, functions, or guides.
- Decide whether content should come from schema descriptions, templates, or both.
2. 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.
3. Add or update template files in docs/.
- Create only files that map to implemented provider objects.
- Use HashiCorp-recommended template paths:
docs/index.md.tmpldocs/data-sources/<name>.md.tmpldocs/resources/<name>.md.tmpldocs/ephemeral-resources/<name>.md.tmpldocs/list-resources/<name>.md.tmpldocs/functions/<name>.md.tmpldocs/guides/<name>.md.tmpl- Keep templates focused on overview and examples; rely on generated sections for field-by-field details.
4. Generate documentation with tfplugindocs.
- Prefer repository defaults when configured:
go generate ./...- Otherwise run the generator directly:
go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs generate --provider-name <provider_name>- Re-run generation after every schema or template edit.
5. Validate the generated markdown.
- Verify files in
docs/match the current provider implementation. - Verify examples are valid HCL and reflect current argument/attribute names.
- Verify required/optional/computed semantics in docs match schema behavior.
6. Apply Registry publication rules before release.
- Use semantic version tags prefixed with
v(for examplev1.2.3). - Create release tags from the default branch.
- Keep
terraform-registry-manifest.jsonin the repository root. - Expect docs to be versioned in Registry and switchable with the version selector.
7. Preview or troubleshoot publication when needed.
- Use the HashiCorp preview process to inspect rendered docs before release when accuracy risk is high.
- If docs are missing in Registry, check tag format, tag source branch, manifest file presence, and provider publication status.
Enforce Quality Bar
- Keep documentation behaviorally accurate; never describe unsupported arguments or attributes.
- Keep examples minimal, realistic, and runnable.
- Keep terminology and naming consistent across provider, resources, and data sources.
- Avoid duplicating generated argument/attribute blocks in manual templates.
- Keep doc changes tied to the same PR as schema/API changes whenever possible.
Load References On Demand
- Read
references/hashicorp-provider-docs.mdfor source-backed rules and official links. - Load only the sections needed for the current change to keep context lean.
# Copyright IBM Corp. 2025, 2026
# SPDX-License-Identifier: MPL-2.0
interface:
display_name: "Terraform Provider Docs"
short_description: "Best practices for Terraform provider docs"
default_prompt: "Use $terraform-provider-docs to create or update Terraform Registry provider documentation with HashiCorp-aligned structure and style."
HashiCorp Provider Documentation Reference
Source of truth for this skill:
- https://developer.hashicorp.com/terraform/registry/providers/docs
Core Rules
- Publish provider docs through Terraform Registry using
tfplugindocs. - Generate provider docs from schema descriptions and markdown templates.
- Store templates under the repository
docs/directory with expected naming conventions. - Keep release tags and manifest metadata valid so Registry can render and display docs.
Template Paths
Use these template paths when the corresponding provider objects exist:
docs/index.md.tmpldocs/data-sources/<name>.md.tmpldocs/resources/<name>.md.tmpldocs/ephemeral-resources/<name>.md.tmpldocs/list-resources/<name>.md.tmpldocs/functions/<name>.md.tmpldocs/guides/<name>.md.tmpl
Generation Workflow
HashiCorp recommends wiring generator execution through go generate:
//go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs generate --provider-name <provider_name>Run from repository root:
go generate ./...Alternative direct execution:
go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs generate --provider-name <provider_name>Release and Publication Constraints
- Use semantic version tags prefixed with
v. - Create tags from the default branch.
- Keep
terraform-registry-manifest.jsonin the repository root. - Understand docs appear by provider version in Registry once the provider release is published.
Preview and Troubleshooting
- Use HashiCorp's preview process to verify rendering before release when needed.
- If docs are missing or stale in Registry, verify:
- tag naming and tag branch source
- manifest file presence and validity
- provider version publication state
Related Canonical Pages
- Provider docs guidance:
- https://developer.hashicorp.com/terraform/registry/providers/docs
- Terraform Plugin Docs (
tfplugindocs) source and usage: - https://github.com/hashicorp/terraform-plugin-docs
Related skills
Azure AiIntegrates Azure AI Content Safety, Document Intelligence, Speech, and Search services into Java-based agents and applications.495k1.4kAzure PrepareGenerate the exact Azure infrastructure files, Dockerfiles, and azure.yaml configuration needed before deploying any new or modernized application.494k1.4kAzure StorageConnect agents and applications to Azure Blob Storage, File Shares, Queues, Tables, and Data Lake without leaving the coding environment.494k1.4kAppinsights InstrumentationAutomatically instrument web applications running on Azure App Service with Application Insights for observability without manual configuration.493k1.4kAzure Resource LookupInstantly list, query, and discover any Azure resources across subscriptions without leaving the agent chat.493k1.4kAzure AigatewayConfigure Azure API Management as a secure, governed gateway for routing traffic to LLMs, MCP servers, and agent tools.493k1.4kForks & variants (1)
Provider Docs has 1 known copy in the catalog totaling 32 installs. They canonicalize to this original listing.
- hashicorp - 32 installs
How it compares
Choose provider-docs over generic technical-writing skills when the output must meet Terraform Registry publishing requirements and tfplugindocs conventions.
FAQ
Who is provider-docs for?
Developers and software engineers working with provider-docs patterns described in the skill documentation.
When should I use provider-docs?
When Create, update, and review Terraform provider documentation for Terraform Registry using HashiCorp-recommended patterns, tfplugindocs templates, and schema descriptions. Use when a.
Is provider-docs safe to install?
Review the Security Audits panel on this page before installing in production.