terraform-documentation-generator

Generate Terraform module README files with terraform-docs.

29|7|Updated Oct 13, 2025
One-click install
npx skills add https://github.com/armanzeroeight/fastagent-plugins --skill terraform-documentation-generator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: terraform-documentation-generator
Source: https://github.com/armanzeroeight/fastagent-plugins/tree/main/plugins/terraform-toolkit/skills/terraform-documentation-generator
Command: npx skills add https://github.com/armanzeroeight/fastagent-plugins --skill terraform-documentation-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the generation and maintenance of documentation for Terraform modules, ensuring consistency and saving developers significant time.

Core Features & Use Cases

  • Automated README Generation: Creates or updates README.md files for Terraform modules using terraform-docs.
  • Input/Output Tables: Automatically generates tables for module inputs and outputs.
  • Usage Examples: Includes a standard usage block in the generated documentation.
  • Use Case: When developing a new Terraform module or updating an existing one, use this Skill to ensure its documentation is complete, accurate, and follows best practices without manual effort.

Quick Start

Use the terraform-documentation-generator skill to auto-generate the README.md file for the current Terraform module.

Frequently Asked Questions about terraform-documentation-generator

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

FAQPage Schema
How do I auto-generate a README for a Terraform module?

To auto-generate Terraform module documentation, use a tool like terraform-docs to scan your configuration files and produce a README.md with input/output tables, usage examples, and requirements.

What is the best way to keep Terraform module documentation updated?

The best way to keep Terraform module documentation updated is integrating terraform-docs into pre-commit hooks or CI/CD pipelines, ensuring your README.md automatically reflects code changes during development.

Does terraform-docs support generating input and output tables?

Yes, terraform-docs supports generating input and output tables. It analyzes your Terraform code structure to automatically populate module documentation with accurate variables and outputs.

Can I use this documentation generation approach in a CI/CD pipeline?

Yes, you can use this documentation generation approach in a CI/CD pipeline. The tool integrates with CI/CD workflows to continuously update README files without manual intervention whenever Terraform code changes.

What should be included in Terraform IaC documentation?

Terraform IaC documentation should include input/output tables, usage examples, and module requirements. Automating this with terraform-docs ensures consistency and saves significant development time.