terraform-doc-generator

To generate a Terraform module README.md automatically, this Skill parses your variables, outputs, resources, and provider requirements to produce a complete document with usage examples and consistent formatting.

Keeping Terraform module documentation consistent is achieved by automating the extraction of variables and outputs to generate standardized sections for inputs, requirements, providers, and usage examples.

Yes, you can parse Terraform files like main.tf, variables.tf, outputs.tf, and versions.tf to surface metadata and produce accurate tables alongside ready-to-edit example content for quick start.

Yes, this Terraform documentation generator supports a range of module structures, applying the parsed metadata to produce structured sections for inputs, outputs, requirements, providers, and resources.

An auto-generated Terraform module README includes structured sections for usage, inputs, outputs, requirements, providers, and resources, while also attaching metadata such as license and contribution guidelines.

Terraform module documentation falls out of sync when maintained manually, so automating the extraction of variables, outputs, and resources ensures your README accurately reflects your current codebase.