terraform-docs

What problem does it solve?

This Skill automates the creation of comprehensive documentation directly from Terraform code, eliminating the manual effort and ensuring accuracy.

Core Features & Use Cases

• Module READMEs: Generate standard documentation for reusable Terraform modules.
• Architecture Documentation: Create high-level overviews of infrastructure designs.
• Operational Runbooks: Develop step-by-step guides for deployment and maintenance.
• Quick Reference Guides: Provide concise cheat sheets for common commands and configurations.
• Use Case: When you've just finished writing a new Terraform module for creating VPCs, use this Skill to automatically generate a README file that details its inputs, outputs, and provides usage examples.

Quick Start

Use the terraform-docs skill to generate a module README for the Terraform code in the current directory.