Imported from devopsvanilla/gcp-terraform-ansible-samples (
.agents/skills/poc-readme-validator/SKILL.md). Install upstream withnpx skills add devopsvanilla/gcp-terraform-ansible-samples --skill poc-readme-validator. Copyright stays with the author.
Skill: POC README Validator
Esta skill garante que a documentação de cada POC siga rigorosamente a estrutura exigida pelo repositório.
Quando Utilizar esta Skill
- Ao criar ou atualizar o
README.mdde qualquer POC emPoCs/<nome-da-poc>/. - Durante a fase de validação de PRs ou Quality Gates de documentação.
Regras de Estrutura do README de POC
O arquivo PoCs/<nome-da-poc>/README.md deve obrigatoriamente conter exatamente as 6 seções abaixo, na seguinte ordem exata (títulos H2 ou H3):
-
O que será implantado
- Descrição sucinta da arquitetura e recursos GCP criados (Compute Engine, VPC, Storage, etc.).
- Indicação explicita de custos/limitações esperados.
-
Pré-requisitos
- Ferramentas necessárias (
gcloud,terraform,ansible,bash). - Permissões mínimas GCP / Roles necessárias no projeto.
- APIs do Google Cloud que precisam estar habilitadas.
- Ferramentas necessárias (
-
Como implantar
- Comandos passo a passo para autenticação, inicialização e aplicação do Terraform (
gcloud auth,terraform init,terraform apply). - Passos para execução do Ansible caso aplicável.
- Comandos passo a passo para autenticação, inicialização e aplicação do Terraform (
-
Como conferir a implantação
- Comandos de validação concretos via CLI (
gcloud compute instances list,curl,ping, etc.) e/ou verificação via Console Web GCP.
- Comandos de validação concretos via CLI (
-
Como descomissionar
- Instruções exatas e seguras para destruição dos recursos (
terraform destroy) evitando custos residuais no GCP.
- Instruções exatas e seguras para destruição dos recursos (
-
Guia de erros comuns
- Problemas conhecidos (ex: API desabilitada, cota excedida, erro de permissão IAM, SSH falhando) e como resolvê-los.
Regras de Redação
- Linguagem direta e reproduzível para analistas de nível júnior.
- Comandos formatados em blocos de código markdown (
bash ...). - Proibido omitir qualquer uma das 6 seções.