provider-docs

Generate Terraform provider documentation from schema descriptions and markdown templates.

790|117|Updated Nov 8, 2025
One-click install
npx skills add https://github.com/hashicorp/agent-skills --skill provider-docs-hashicorp
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: provider-docs
Source: https://github.com/hashicorp/agent-skills/tree/main/terraform/provider-development/skills/provider-docs
Command: npx skills add https://github.com/hashicorp/agent-skills --skill provider-docs-hashicorp

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires tfplugindocs, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation, update, and review of Terraform provider documentation for Terraform Registry, ensuring compliance with HashiCorp standards and improving efficiency in documentation processes.

Core Features & Use Cases

  • Documentation Creation: Automates the generation of documentation for Terraform providers based on schema descriptions and markdown templates.
  • Review & Validation: Provides tools for validating the accuracy and completeness of generated documentation.
  • Use Case: Ideal for developers and maintainers of Terraform providers looking to streamline the documentation process and ensure adherence to best practices.

Quick Start

Run the tfplugindocs command with the provider name to generate documentation for your Terraform provider.

Frequently Asked Questions about provider-docs

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

FAQPage Schema
How do I automate Terraform provider documentation generation?

To automate Terraform provider documentation generation, use the tfplugindocs command with your provider name to generate docs from schema descriptions and markdown templates. This ensures compliance with HashiCorp standards while streamlining the creation process.

What is tfplugindocs used for in Terraform provider development?

Terraform provider documentation generation with tfplugindocs is used to automatically create and update registry docs from schema descriptions and markdown templates. It validates accuracy and supports review processes to maintain documentation compliance.

How do I validate Terraform provider documentation accuracy?

To validate Terraform provider documentation accuracy, use the review and validation tools provided by the tfplugindocs workflow. These tools check the completeness and accuracy of generated markdown templates against your schema descriptions.

Does Terraform provider documentation generation work with existing markdown templates?

Yes, Terraform provider documentation generation works with existing markdown templates by combining them with schema descriptions. This approach automates updates while maintaining your custom documentation structure for the Terraform Registry.

Do I need tfplugindocs to maintain Terraform Registry documentation?

Yes, you need tfplugindocs to maintain Terraform Registry documentation efficiently. It serves as the core dependency for automating documentation creation, validation, and publication processes while ensuring adherence to HashiCorp standards.