Terraform Documentation Generator

About

This skill streamlines the documentation process for Infrastructure as Code by leveraging the terraform-docs tool to automatically generate input, output, and resource tables. It provides comprehensive guidance on configuring documentation workflows, from setting up .terraform-docs.yml files to integrating documentation checks into pre-commit hooks and CI/CD pipelines. By enforcing consistent formatting and extracting metadata directly from HCL files, it ensures that Terraform modules remain well-documented and easy for teams to consume without manual overhead.

Key Features

• Support for injecting documentation into existing README files using markers
• Automatic generation of input, output, and resource reference tables
• Integration patterns for pre-commit hooks and GitHub Actions automation
• Standardized configuration using .terraform-docs.yml for consistent formatting
• 16 GitHub stars
• Guidelines for documenting HCL variables, outputs, and header comments

Use Cases

• Enforcing documentation standards across multiple cloud infrastructure projects
• Creating professional README.md files for new Terraform modules
• Automatically updating documentation after infrastructure changes or variable updates