Will it overwrite my manual documentation additions?

No, the skill includes a 'Custom Sections' feature using specific markers that allows you to protect manually written content during automated regeneration.

Does it support complex multi-environment setups?

Yes, it detects environment-specific directories (such as dev, staging, or prod) and tailors the documentation to include resource counts and specific access patterns for those contexts.

How does this improve DevOps workflows?

It eliminates documentation drift by ensuring that changes in your code—like new variables or resources—are immediately reflected in the documentation, improving team onboarding and incident response.

Can it generate visual architecture diagrams?

Yes, it uses Mermaid.js syntax to create text-based architecture diagrams that render natively in version control platforms like GitHub and GitLab.

What infrastructure tools does this skill support?

It is primarily designed for Terraform and OpenTofu workflows, parsing .tf files to extract variables, outputs, and resource definitions.

Auto-Documentation for DevOps

Name: Auto-Documentation for DevOps
Author: lgbarn

bylgbarn

Deployment & DevOps

Automates the creation of comprehensive Terraform module READMEs, environment guides, and operational runbooks directly from infrastructure code.

About

The auto-documentation skill streamlines the maintenance of infrastructure-as-code documentation by automatically parsing Terraform and OpenTofu files to generate high-quality READMEs, environment inventories, and runbooks. It extracts variables, outputs, and resources to build structured tables and uses Mermaid.js to visualize architecture, ensuring that documentation remains in sync with the actual deployed infrastructure. This skill is ideal for DevOps engineers looking to maintain professional-grade documentation standards without the manual overhead, offering standardized templates for modules, multi-environment setups, and emergency procedures.

Key Features

Dynamic Mermaid.js architecture diagram generation from infrastructure code
Environment-specific documentation including resource inventories and access patterns
Preservation of custom manual content using dedicated comment markers
0 GitHub stars
Automated Terraform module README generation with resource and variable tables
Operational runbooks for troubleshooting, scaling, and emergency procedures

Use Cases

Standardizing documentation across a library of reusable Terraform modules
Generating up-to-date environment guides for dev, staging, and production stacks
Creating searchable operational runbooks for incident response and on-call rotations

About

Key Features

Dynamic Mermaid.js architecture diagram generation from infrastructure code
Environment-specific documentation including resource inventories and access patterns
Preservation of custom manual content using dedicated comment markers
0 GitHub stars
Automated Terraform module README generation with resource and variable tables
Operational runbooks for troubleshooting, scaling, and emergency procedures

Use Cases

Standardizing documentation across a library of reusable Terraform modules
Generating up-to-date environment guides for dev, staging, and production stacks
Creating searchable operational runbooks for incident response and on-call rotations