Pular para o conteúdo

Catálogo das 11 Agent Skills

O catálogo contém seis Agent Skills essenciais (P0) e cinco avançadas (P1). Instale apenas as necessárias para a tarefa. Cada skill pode funcionar individualmente.

As instruções ficam no repositório ADR Guard. Cada entrada descreve um fluxo para o agente, não um novo comando da CLI.

Quando usar: iniciar a documentação de ADRs em um repositório, selecionar diretórios, formatos e templates.

Faz: examina configuração e registros, visualiza adr-guard init ... --dry-run e inicializa com autorização. Não faz: sobrescrever políticas ou migrar ADRs sem consentimento.

Ler a skill · Referência da CLI

Quando usar: documentar uma escolha arquitetural relevante.

Faz: reúne restrições e alternativas, seleciona Minimal/Extended/Custom canônico, visualiza adr-guard new e cria registro Proposed quando autorizado. O draft com IA exige provedor, modelo e autorização para transmitir contexto. Não faz: aceitar decisões nem gerar MADR com new.

Ler a skill · Guia de criação

Quando usar: validar estrutura, links, relacionamentos e falhas na CI.

Faz: executa adr-guard check, interpreta diagnósticos e opcionalmente atualiza o índice após validação bem-sucedida. Não faz: confundir validade estrutural com aprovação técnica.

Ler a skill · Relatórios

Quando usar: avaliar justificativas, alternativas, requisitos não funcionais, riscos, segurança e viabilidade de uma proposta.

Faz: apresenta sugestões fundamentadas ou executa adr-guard review com provedor, modelo e contexto explicitamente autorizados. Não faz: aprovar arquitetura, certificar conformidade ou enviar arquivos silenciosamente a terceiros.

Ler a skill · Revisão com IA

Quando usar: manter transições de status autorizadas e preservar o histórico.

Faz: verifica Proposed, Accepted, Deprecated, Superseded e status adicionais configurados; valida links declarados. Não faz: presumir aprovação por merge ou sucesso nos testes.

Ler a skill · Ciclo de vida

Quando usar: configurar validação de ADRs no GitHub Actions.

Faz: orienta workflows de command: check com privilégio mínimo, verificações obrigatórias e SARIF opcional. Não faz: executar revisões privilegiadas com IA em PRs não confiáveis.

Ler a skill · Guia da Action

Quando usar: avaliar se impacto, reversibilidade, alcance ou risco justificam um ADR.

Faz: recomenda ADR, documentação mais simples ou experimento. Não faz: exigir um ADR para cada tarefa.

Ler a skill · Quando registrar

Quando usar: comparar alternativas viáveis antes de propor uma decisão.

Faz: organiza critérios, premissas, evidências, alternativas e riscos para apoiar um ADR Extended. Não faz: inventar notas, benchmarks ou uma opção vencedora definitiva.

Ler a skill · Como escrever boas ADRs

Quando usar: substituir uma decisão previamente aceita sem apagar seu histórico.

Faz: cria novo registro Proposed, preserva o anterior e declara Supersedes / Superseded by após aprovação humana. Não faz: desativar a decisão anterior enquanto a substituta não estiver aceita.

Ler a skill · Exemplo de substituição

Quando usar: examinar qualidade documental e lacunas de governança em um acervo de ADRs.

Faz: executa check --format json em modo somente leitura, analisa evidências e propõe melhorias. Não faz: declarar architectural drift na implementação nem alterar status automaticamente.

Ler a skill · Segurança

Quando usar: implementar a prática de propor, revisar, aceitar e manter ADRs em equipe.

Faz: sugere critérios de relevância, responsáveis, templates, piloto e integração à CI. Não faz: impor política organizacional sem aprovação das pessoas responsáveis.

Ler a skill · Guia para equipes

  • Antes de escrever: when-to-record → tradeoff-analysis → create.
  • Melhorar o ADR: validate verifica regras; technical-review orienta sobre arquitetura.
  • Substituir uma escolha aceita: supersede com apoio de lifecycle.
  • Manter a prática: audit, team-adoption, init e ci-setup.

Instalação · Exemplos práticos · Limites de governança