lgbarn/devops-skills/auto-documentation

# Module: [module-name]
 
[Brief description of what this module provisions]
 
## Requirements
 
| Name | Version |
|------|---------|
| terraform | >= X.Y.Z |
| aws | >= X.Y.Z |
 
## Providers
 
| Name | Version |
|------|---------|
| aws | X.Y.Z |
 
## Resources
 
| Name | Type |
|------|------|
| aws_instance.this | resource |
| aws_security_group.this | resource |
 
## Inputs
 
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| name | Name prefix for resources | `string` | n/a | yes |
| vpc_id | VPC ID | `string` | n/a | yes |
 
## Outputs
 
| Name | Description |
|------|-------------|
| instance_id | ID of the created instance |
| public_ip | Public IP address |
 
## Usage
 

 
## Architecture
 
[Optional: Mermaid diagram of resources]
 
## Notes
 
[Any important considerations, limitations, or gotchas]

# Environment: [env-name]
 
## Overview
 
[Purpose and scope of this environment]
 
## Resource Inventory
 
| Category | Resource Type | Count | Key Resources |
|----------|--------------|-------|---------------|
| Compute | aws_instance | 5 | web-1, web-2, api-1 |
| Database | aws_rds_instance | 2 | primary, replica |
| Network | aws_vpc | 1 | main-vpc |
 
## Architecture Diagram
 

 
## Access Patterns
 
| Service | Port | Source | Purpose |
|---------|------|--------|---------|
| ALB | 443 | 0.0.0.0/0 | Public HTTPS |
| Web | 8080 | ALB | Internal traffic |
 
## Dependencies
 
- [External services or accounts this depends on]
 
## Deployment
 
[How to deploy changes to this environment]

# Runbook: [service/component]
 
## Overview
 
[What this runbook covers]
 
## Common Operations
 
### Starting/Stopping
 

 
### Scaling
 

 
### Health Checks
 

 
## Troubleshooting
 
### Problem: High CPU Usage
 
**Symptoms:** CPU > 80% sustained
 
**Investigation:**
1. Check CloudWatch metrics
2. Review application logs
3. Check for runaway processes
 
**Resolution:**
- Scale horizontally if traffic-related
- Restart instance if process issue
 
### Problem: Connection Timeouts
 
**Symptoms:** 504 errors at load balancer
 
**Investigation:**
1. Check target group health
2. Verify security group rules
3. Check application logs
 
**Resolution:**
- [Steps to resolve]
 
## Emergency Procedures
 
### Service Outage
 
1. **Assess**: Check CloudWatch alarms
2. **Communicate**: Notify stakeholders
3. **Mitigate**: [Immediate actions]
4. **Resolve**: [Fix steps]
5. **Review**: Post-incident analysis
 
### Rollback Procedure
 

 
## Contacts
 
| Role | Name | Contact |
|------|------|---------|
| On-call | [Team] | [Contact] |
| Escalation | [Manager] | [Contact] |

# Find all Terraform files
find . -name "*.tf" -type f
 
# Extract structure
grep -h "^variable\|^output\|^resource\|^module" *.tf

<!-- BEGIN CUSTOM -->
Your custom content here
<!-- END CUSTOM -->