Estratégias de documentação em terraform em Terraform

Prompt gerado automaticamente para Documentação em Terraform em Terraform

5.0
33 usos
ChatGPT
Usar no ChatGPT
"Atuando como um especialista em Terraform e documentação técnica, elabore um guia passo a passo detalhado e didático (em português brasileiro, com exemplos de código quando aplicável) para uma equipe de desenvolvimento que está migrando para Terraform pela primeira vez. O foco principal deve ser em como criar e manter uma documentação de código Terraform eficaz e sustentável, abordando as seguintes questões:

1.  **Estrutura Ideal:** Qual a melhor estrutura de diretórios e arquivos para organizar a documentação de projetos Terraform complexos? Inclua exemplos práticos para módulos, workspaces e configurações de provedores.
2.  **Ferramentas e Automação:** Quais ferramentas (nativas ou de terceiros) podem ser utilizadas para gerar e manter a documentação automaticamente? Como integrar a geração de documentação no pipeline CI/CD?
3.  **Conteúdo Essencial:** O que é crucial documentar em cada bloco de código Terraform (recursos, variáveis, outputs, módulos, provedores)? Como garantir que a documentação reflita o estado real da infraestrutura?
4.  **Melhores Práticas:** Quais são as melhores práticas para garantir que a documentação seja clara, concisa, fácil de encontrar e sempre atualizada? Como lidar com a evolução do código e a depreciação de recursos na documentação?
5.  **Exemplos Práticos:** Forneça exemplos de blocos de documentação bem escritos para cenários comuns, como um módulo de VPC, um recurso de instância EC2 com variáveis e outputs, e a configuração de um provedor AWS.

O guia deve ser prático, acionável e focado em capacitar a equipe a criar uma cultura de documentação robusta, minimizando a 'dívida de documentação' e facilitando a colaboração e a manutenção a longo prazo."

Como Usar este Prompt

1

Clique no botão "Copiar Prompt" para copiar o conteúdo completo.

2

Abra sua ferramenta de IA de preferência (ChatGPT e etc.).

3

Cole o prompt e substitua as variáveis (se houver) com suas informações.

Compartilhe

Gostou deste prompt? Ajude outras pessoas a encontrá-lo!

Outros prompts de Terraform

Continue explorando prompts nesta categoria.

Melhores práticas de casos de uso práticos em terraform para Terraform

Prompt gerado automaticamente para Casos de uso práticos em Terraform em Terraform

Melhores práticas de casos de uso práticos em terraform para Terraform

Prompt gerado automaticamente para Casos de uso práticos em Terraform em Terraform

Guia para testing em terraform em Terraform

Prompt gerado automaticamente para Testing em Terraform em Terraform