Playbook IA & Automação — Documento Completo
Pagina Inicial
Este playbook é o recurso central para a nossa prática de consultoria em IA. Ele oferece um framework abrangente, metodologia e um conjunto de melhores práticas para garantir consistência, qualidade e sucesso em todos os nossos engajamentos com clientes.
Nossa Missão
Capacitar nossos consultores a entregar valor excepcional aos clientes, alavancando tecnologias de IA de ponta e uma abordagem padronizada e repetível.
Como Usar Este Playbook
Este site está organizado em seções chave acessíveis pela barra de navegação superior. Seja você começando um novo projeto, avaliando a maturidade de IA de um cliente, ou procurando orientação técnica específica, este playbook é seu primeiro ponto de referência.
- Novos Consultores: Comece com as seções Introdução e Metodologia.
- Início de Projeto: Use as seções Avaliação de Maturidade e Fluxo de Engajamento.
- Implementação Técnica: Consulte as seções Orientações Técnicas e Templates.
Este playbook é um documento vivo. Por favor, consulte a seção Contribuição para detalhes sobre como fornecer feedback e contribuir.
Seção 1 — Introdução
Este Playbook de Consultoria em IA é o guia central para a nossa prática, projetado para capacitar nossas equipes a entregar projetos de Inteligência Artificial de alto impacto com consistência, qualidade e agilidade. Ele consolida nossa metodologia, melhores práticas e artefatos reutilizáveis.
1.1 1.1 Propósito deste Playbook
O objetivo principal é fornecer um framework estruturado que guie cada fase de um engajamento de consultoria em IA, desde a estratégia inicial até a operação contínua. Ao padronizar nossa abordagem, garantimos que todos os clientes se beneficiem do conhecimento coletivo e da excelência técnica de nossa equipe.
1.2 1.2 Princípios Fundamentais
Nossa metodologia é construída sobre um alicerce de princípios não negociáveis que garantem o sucesso e a sustentabilidade de nossas soluções.
1.2.1 1.2.1 Foco em Valor de Negócio
Toda iniciativa de IA deve estar diretamente ligada a um objetivo de negócio claro e mensurável. Priorizamos casos de uso que ofereçam o maior retorno sobre o investimento (ROI) e que sejam viáveis de implementar.
1.2.2 1.2.2 IA Responsável
Estamos comprometidos com o desenvolvimento e a implantação de sistemas de IA que sejam éticos, justos, transparentes e seguros. Nossas soluções devem ser projetadas para minimizar vieses, proteger a privacidade dos dados e ser compreensíveis para os stakeholders.
1.2.3 1.2.3 Excelência Técnica e Operacional
Buscamos a excelência em todo o ciclo de vida do projeto, desde o desenho da arquitetura até a implantação e monitoramento. Adotamos padrões de MLOps/LLMOps para criar soluções robustas, escaláveis e de fácil manutenção.
1.3 1.3 Proposta de Valor para o Cliente
Ao adotar nosso framework, nossos clientes podem esperar:
- Aceleração do Time-to-Value: Redução do tempo entre a concepção de uma ideia e a sua implementação em produção.
- Redução de Riscos: Mitigação de riscos técnicos e de negócio através de uma metodologia comprovada e foco em IA Responsável.
- Acesso a Melhores Práticas: Benefício de um conjunto de padrões de arquitetura, templates e processos refinados.
- Retorno sobre o Investimento (ROI) Claro: Foco em métricas que demonstram o valor tangível gerado pelas iniciativas de IA.
1.4 1.4 Glossário
Esta seção define os termos e acrônimos chave utilizados ao longo do playbook para garantir um entendimento comum.
- IA Generativa (Gen AI): Classe de modelos de IA capazes de criar novo conteúdo, como texto, imagens ou código.
- LLM (Large Language Model): Um modelo de linguagem com um grande número de parâmetros, treinado em vastos volumes de texto (ex: GPT-4).
- SLM (Small Language Model): Um modelo de linguagem menor, mais focado e otimizado para tarefas específicas ou para rodar em ambientes com menos recursos.
- RAG (Retrieval-Augmented Generation): Um padrão de arquitetura onde um LLM consulta uma base de conhecimento externa (geralmente uma Vector DB) para obter contexto antes de gerar uma resposta.
- Fine-Tuning (Ajuste Fino): O processo de continuar o treinamento de um modelo de IA pré-treinado em um conjunto de dados menor e específico para uma tarefa particular.
- MLOps/LLMOps: Um conjunto de práticas que visa implantar e manter modelos de machine learning (ou LLMs) em produção de forma confiável e eficiente.
Seção 2 — Avaliação de Maturidade (Assessment)
A avaliação de maturidade em IA é o ponto de partida estratégico para qualquer jornada de transformação digital. Este processo diagnóstico nos permite obter uma compreensão profunda e multifacetada da prontidão de uma organização para alavancar a Inteligência Artificial, identificando não apenas as capacidades existentes, mas também as lacunas e oportunidades críticas para o crescimento.
O resultado é um mapa claro que nos orienta na criação de um roadmap de IA personalizado, pragmático e alinhado aos objetivos de negócio do cliente.
2.1 2.1 O Modelo de Maturidade de IA
Nosso modelo proprietário avalia a maturidade em quatro níveis progressivos. Cada nível representa um salto qualitativo em como a organização utiliza dados, tecnologia, processos e talentos para gerar valor com IA.
2.1.1 2.1.1 Nível 1: Inicial
Características: Adoção de IA inexistente ou limitada a esforços isolados e não documentados. A cultura de dados é fraca, e os dados são frequentemente armazenados em silos, com baixa qualidade e difícil acesso. Não há talentos especializados em IA ou ciência de dados. As decisões são tomadas com base na intuição, não em dados.
Foco da Consultoria: Evangelização sobre o potencial da IA, identificação de "quick wins" e início da jornada de aculturação de dados.
2.1.2 2.1.2 Nível 2: Emergente
Características: Primeiras provas de conceito (PoCs) de IA são iniciadas, geralmente em áreas específicas e de forma experimental. Há uma consciência crescente sobre a importância dos dados, com esforços iniciais para centralizá-los e limpá-los. Equipes pequenas e dedicadas começam a se formar.
Foco da Consultoria: Estruturação de projetos piloto, definição de uma estratégia de dados formal e capacitação das equipes técnicas iniciais.
2.1.3 2.1.3 Nível 3: Competente
Características: A IA está integrada em processos de negócio chave, gerando valor comprovado. A governança de dados é uma prática estabelecida. A infraestrutura de nuvem e as plataformas de MLOps/LLMOps são utilizadas para escalar as soluções. As equipes de IA são multidisciplinares e colaboram com as áreas de negócio.
Foco da Consultoria: Otimização e escalonamento das soluções existentes, fortalecimento da governança e expansão da cultura de IA para toda a organização.
2.1.4 2.1.4 Nível 4: Líder
Características: A IA é um pilar central da estratégia de negócio, impulsionando a inovação e a vantagem competitiva. O acesso a dados e ferramentas de IA é democratizado. Ciclos de inovação são rápidos, com re-treinamento e melhoria contínua de modelos. A IA Responsável é uma prática auditável e integrada em todo o ciclo de vida.
Foco da Consultoria: Co-criação de novas frentes de inovação, exploração de tecnologias de ponta e otimização do ROI em escala.
2.2 2.2 Questionários Diagnósticos
Para avaliar o nível de maturidade, conduzimos uma análise 360° através de questionários detalhados, organizados em quatro pilares fundamentais.
2.2.1 2.2.1 Pilar 1 — Negócio
Objetivo: Entender o alinhamento estratégico da IA com os objetivos da empresa.
Exemplos de tópicos avaliados: - Existe um executivo (C-level) patrocinando a estratégia de IA? - Os casos de uso de IA estão claramente ligados a KPIs de negócio? - Como a concorrência está utilizando IA? - Existe um comitê de ética para supervisionar as iniciativas de IA?
2.2.2 2.2.2 Pilar 2 — Dados
Objetivo: Avaliar a qualidade, disponibilidade e governança dos ativos de dados.
Exemplos de tópicos avaliados: - Os dados críticos para o negócio estão centralizados em um Data Lake ou Lakehouse? - Qual é o processo para garantir a qualidade e a linhagem dos dados? - A organização possui uma estratégia para dados não estruturados (texto, imagens, etc.)? - A Lei Geral de Proteção de Dados (LGPD) é aplicada na gestão de dados?
2.2.3 2.2.3 Pilar 3 — Infraestrutura e Tecnologia
Objetivo: Mapear a prontidão da arquitetura tecnológica para suportar o ciclo de vida da IA.
Exemplos de tópicos avaliados: - Qual provedor de nuvem é utilizado e qual a maturidade de seu uso? - Existe uma plataforma de MLOps/LLMOps para automação de deploy e monitoramento? - Como é feita a gestão de segredos e chaves de API para serviços de IA? - A capacidade computacional (GPUs) é adequada para os casos de uso planejados?
2.2.4 2.2.4 Pilar 4 — Pessoas e Cultura
Objetivo: Analisar as habilidades da equipe e a cultura organizacional para a adoção da IA.
Exemplos de tópicos avaliados: - Quais são os papéis e responsabilidades das equipes de dados e IA? - Existe um plano de capacitação e contratação para talentos de IA? - A cultura da empresa incentiva a experimentação e aceita o erro como parte do processo de inovação? - Como as áreas de negócio e tecnologia colaboram em projetos de IA?
2.3 2.3 Guia de Pontuação e Entregável
As respostas dos questionários são pontuadas de acordo com um guia de critérios objetivos, resultando em uma visualização clara da maturidade da organização.
Entregável Visual: O resultado é frequentemente apresentado em um gráfico de radar (Radar Chart), mostrando a pontuação de 0 a 4 para cada um dos pilares e para as sub-dimensões. Isso permite uma identificação visual e imediata dos pontos fortes e das áreas que necessitam de maior atenção.
Relatório de Assessment: O gráfico de radar é acompanhado de um relatório detalhado que contém:
- Sumário Executivo: Resumo das principais conclusões e recomendações.
- Análise por Pilar: Detalhamento dos pontos fortes e fracos em Negócio, Dados, Infraestrutura e Pessoas.
- Nível de Maturidade Geral: Classificação da organização em um dos quatro níveis do modelo.
- Recomendações Estratégicas: Ações de alto nível para evoluir a maturidade em IA.
- Roadmap Sugerido: Primeiras iniciativas e projetos recomendados com base nos achados.
Seção 3 — Metodologia de Consultoria (Fases do Projeto)
Nossa metodologia de consultoria adota uma abordagem ágil e iterativa para maximizar o valor entregue, permitir adaptação contínua e garantir que as soluções de Inteligência Artificial estejam alinhadas às necessidades em constante evolução do negócio. Cada fase é desenhada para ser colaborativa, transparente e focada em resultados tangíveis.
Este documento integra o fluxo de engajamento do cliente e um checklist prático dentro de cada fase, oferecendo um guia completo e acionável.
3.1 3.1 Fase 1 — Estratégia e Descoberta (Strategy)
Objetivo: Identificar os casos de uso de IA com maior potencial de valor e alinhá-los com as metas estratégicas do negócio. Nesta fase, focamos em compreender o contexto do cliente, suas dores e seus objetivos de longo prazo.
Regras cadastradas nesta seção
- [Checklist da Fase 1] Análise de Viabilidade Checklist manual v1
Solução viável com tecnologia, dados e orçamento? ROI justificado? - [Checklist da Fase 1] Critérios de Sucesso Checklist manual v1
Como o sucesso será medido (KPIs de negócio, métricas de adoção)? - [Checklist da Fase 1] Definição do Problema de Negócio Checklist manual v1
Problema claramente definido e quantificado em valor? - [Checklist da Fase 1] Escopo Inicial (MVP) Checklist manual v1
Um escopo mínimo viável (MVP) definido para a primeira entrega de valor? - [Checklist da Fase 1] Identificação dos Stakeholders Checklist manual v1
Principais interessados (patrocinadores, usuários, equipe) identificados?
Fluxo de Engajamento do Cliente
- Pré-Engajamento — Contato Inicial e Qualificação: Primeiro ponto de contato. Entendimento do interesse, desafios em alto nível e qualificação da oportunidade. Saída: Decisão de avançar (Go/No-Go) para Workshop.
- Workshop de Descoberta: Reunião aprofundada com stakeholders (negócio e técnico) para entender problemas, requisitos, dados e critérios de sucesso. Saída: Entendimento claro do escopo e requisitos.
- Desenho e Apresentação da Proposta: Elaboração da proposta técnica e comercial baseada no workshop de descoberta. Apresentação para decisão do cliente. Saída: Proposta Comercial e Técnica formalizada.
Checklist da Fase 1
Itens Obrigatórios: - [ ] Definição do Problema de Negócio: Problema claramente definido e quantificado em valor? - [ ] Identificação dos Stakeholders: Principais interessados (patrocinadores, usuários, equipe) identificados? - [ ] Critérios de Sucesso: Como o sucesso será medido (KPIs de negócio, métricas de adoção)?
Itens Recomendados: - [ ] Análise de Viabilidade: Solução viável com tecnologia, dados e orçamento? ROI justificado? - [ ] Escopo Inicial (MVP): Um escopo mínimo viável (MVP) definido para a primeira entrega de valor?
3.2 3.2 Fase 2 — Planejamento e Roadmap (Plan)
Objetivo: Transformar os casos de uso priorizados em um plano de ação concreto, com uma arquitetura de solução detalhada e um roadmap de implementação.
Regras cadastradas nesta seção
- [Checklist da Fase 2] Análise de Riscos Checklist manual v1
Principais riscos identificados e planos de mitigação criados (técnicos, de negócio, éticos)? - [Checklist da Fase 2] Definição da Abordagem de IA Checklist manual v1
Qual tipo de IA será usado (ML customizado, GenAI, Copilot, Agentes)? - [Checklist da Fase 2] Definição de Requisitos Não Funcionais Checklist manual v1
Requisitos de segurança, privacidade, latência, escalabilidade e conformidade documentados? - [Checklist da Fase 2] Desenho da Experiência do Usuário (UX) Checklist manual v1
Interação do usuário final com a solução desenhada? - [Checklist da Fase 2] Mapeamento de Recursos e Dependências Checklist manual v1
Dados, sistemas, APIs e ferramentas necessárias mapeadas e acessíveis? - [Checklist da Fase 2] Prova de Conceito (PoC) Checklist manual v1
Uma PoC desenvolvida para validar a principal hipótese técnica com esforço mínimo?
Fluxo de Engajamento do Cliente
- Kick-off e Alinhamento: Reunião com a equipe do projeto (cliente e consultoria) para alinhar objetivos, responsabilidades e processos de trabalho. Saída: Equipe alinhada e motivada.
- Desenho da Solução Detalhado: Colaboração para detalhar a arquitetura da solução, incluindo tecnologia, dados e experiência do usuário. Saída: Arquitetura da Solução e Desenho de UX/UI.
- Definição do Roadmap: Criação do plano de implementação, com etapas claras, marcos e prazos, focando em entregas iterativas de valor. Saída: Roadmap do Projeto e Cronograma.
Atividade Central — Pilha de IA de 5 Camadas
Utilizamos nosso framework da "Pilha de IA de 5 Camadas" para desenhar uma arquitetura robusta e apresentar ao cliente de forma clara:
- Infraestrutura: Definição da base computacional. Onde a solução rodará (AWS, Azure, GCP, On-premise)? Qual a necessidade de hardware (GPU vs. CPU)?
- Modelos: Seleção dos modelos de IA. Usaremos um LLM ou um SLM? Será um modelo open-source (ex: Llama 3) ou proprietário (ex: GPT-4, Claude 3)? A solução exige fine-tuning?
- Dados: Estratégia de contextualização dos modelos. De onde virão os dados (fontes internas, externas)? Como serão processados (Pipelines de ETL/ELT)? Utilizaremos uma abordagem de RAG com Vector Databases?
- Orquestração: Definição da lógica de negócio e do "cérebro" da aplicação de IA. Como o sistema irá planejar e executar tarefas? Como ele irá interagir com outras ferramentas e APIs (Tool Calling)?
- Aplicação: A camada de interação com o usuário final. Será uma API, um chatbot, uma nova interface de usuário (UI) ou uma integração com um sistema existente?
Checklist da Fase 2
Itens Obrigatórios: - [ ] Definição da Abordagem de IA: Qual tipo de IA será usado (ML customizado, GenAI, Copilot, Agentes)? - [ ] Mapeamento de Recursos e Dependências: Dados, sistemas, APIs e ferramentas necessárias mapeadas e acessíveis? - [ ] Desenho da Experiência do Usuário (UX): Interação do usuário final com a solução desenhada? - [ ] Definição de Requisitos Não Funcionais: Requisitos de segurança, privacidade, latência, escalabilidade e conformidade documentados?
Itens Recomendados: - [ ] Prova de Conceito (PoC): Uma PoC desenvolvida para validar a principal hipótese técnica com esforço mínimo? - [ ] Análise de Riscos: Principais riscos identificados e planos de mitigação criados (técnicos, de negócio, éticos)?
3.3 3.3 Fase 3 — Prontidão e Implementação (Ready & Implement)
Objetivo: Desenvolver, testar, validar e implantar uma Prova de Conceito (PoC) ou um Produto Mínimo Viável (MVP) da solução de IA. Esta fase é a de "mão na massa", executada em ciclos ágeis (sprints).
Regras cadastradas nesta seção
- [Checklist da Fase 3] Análise de IA Responsável Checklist manual v1
Solução avaliada quanto a vieses, equidade, explicabilidade e privacidade? - [Checklist da Fase 3] Criação de "Model Card" Checklist manual v1
Criado para modelos de ML/GenAI (propósito, performance, limitações)? - [Checklist da Fase 3] Estratégia de Implantação (Deploy) Checklist manual v1
Estratégia para produção definida (Canary, Blue/Green, etc.)? - [Checklist da Fase 3] Implementação do Core da Solução Checklist manual v1
Desenvolvimento da lógica principal (pipelines, modelos, prompts, bots) iniciado? - [Checklist da Fase 3] Métricas de Avaliação Específicas Checklist manual v1
Métricas relevantes para o tipo de projeto avaliadas (acurácia, RAGAs, sucesso de tarefa)? - [Checklist da Fase 3] Pipeline de CI/CD (e CT) Checklist manual v1
Pipeline para automatizar integração, deploy e (se aplicável) treinamento contínuo implementado? - [Checklist da Fase 3] Práticas de Código e CI Checklist manual v1
Código versionado (Git) e processo de Integração Contínua (CI) em vigor? - [Checklist da Fase 3] Setup do Ambiente Checklist manual v1
Ambientes (desenvolvimento, testes, produção) configurados e provisionados via código (IaC)? - [Checklist da Fase 3] Teste End-to-End (E2E) Checklist manual v1
O fluxo completo da solução testado (da entrada do usuário à saída final)? - [Checklist da Fase 3] User Acceptance Testing (UAT) Checklist manual v1
Solução validada pelos usuários finais?
Fluxo de Engajamento do Cliente
- Sprints de Desenvolvimento: Colaboração contínua do cliente nos ciclos de desenvolvimento (sprints), com reuniões de revisão e feedback regulares. Saída: Entregas incrementais de funcionalidades.
- Validação com Usuários (UAT): Testes da solução por parte dos usuários finais do cliente para garantir que atende às suas necessidades e expectativas. Saída: Aprovação da solução pelos usuários.
- Revisão de Implantação: Planejamento e aprovação da estratégia de implantação da solução em ambiente de produção. Saída: Estratégia de Deploy definida e aprovada.
Checklist da Fase 3
Itens Obrigatórios: - [ ] Setup do Ambiente: Ambientes (desenvolvimento, testes, produção) configurados e provisionados via código (IaC)? - [ ] Implementação do Core da Solução: Desenvolvimento da lógica principal (pipelines, modelos, prompts, bots) iniciado? - [ ] Teste End-to-End (E2E): O fluxo completo da solução testado (da entrada do usuário à saída final)? - [ ] User Acceptance Testing (UAT): Solução validada pelos usuários finais? - [ ] Estratégia de Implantação (Deploy): Estratégia para produção definida (Canary, Blue/Green, etc.)?
Itens Recomendados: - [ ] Práticas de Código e CI: Código versionado (Git) e processo de Integração Contínua (CI) em vigor? - [ ] Métricas de Avaliação Específicas: Métricas relevantes para o tipo de projeto avaliadas (acurácia, RAGAs, sucesso de tarefa)? - [ ] Análise de IA Responsável: Solução avaliada quanto a vieses, equidade, explicabilidade e privacidade? - [ ] Criação de "Model Card": Criado para modelos de ML/GenAI (propósito, performance, limitações)? - [ ] Pipeline de CI/CD (e CT): Pipeline para automatizar integração, deploy e (se aplicável) treinamento contínuo implementado?
3.4 3.4 Fase 4 — Operação e Melhoria Contínua (Manage & Govern)
Objetivo: Implantar a solução em produção e garantir sua performance, confiabilidade e melhoria contínua ao longo do tempo. Esta fase foca na sustentação e na evolução do valor entregue.
Regras cadastradas nesta seção
- [Checklist da Fase 4] Dashboard de Acompanhamento de KPIs Checklist manual v1
Dashboard criado para stakeholders acompanharem o impacto nos KPIs de negócio? - [Checklist da Fase 4] Mecanismo de Coleta de Feedback do Usuário Checklist manual v1
Processo para coletar, analisar e priorizar feedback dos usuários finais estabelecido? - [Checklist da Fase 4] Monitoramento da Qualidade da IA Checklist manual v1
Performance do componente de IA monitorada em produção (drift, alucinações, sucesso do Copilot)? - [Checklist da Fase 4] Monitoramento da Saúde da Aplicação Checklist manual v1
Saúde da infraestrutura e da aplicação monitorada (CPU, memória, latência, erros)? - [Checklist da Fase 4] Plano de Sustentação e Melhoria Checklist manual v1
Plano para corrigir bugs, fazer melhorias e retreinar modelos (se aplicável) definido?
Fluxo de Engajamento do Cliente
- Monitoramento e Suporte: Monitoramento contínuo da solução em produção e suporte técnico para garantir a estabilidade e performance. Saída: Relatórios de Performance e Suporte contínuo.
- Coleta de Feedback e Otimização: Processo estruturado para coletar feedback dos usuários e identificar oportunidades de melhoria e novas funcionalidades. Saída: Plano de Melhoria Contínua e Novas Features.
- Revisões Periódicas de Valor: Reuniões periódicas para avaliar o impacto da solução nos KPIs de negócio e discutir a evolução da estratégia de IA. Saída: Alinhamento Estratégico e Otimização de ROI.
Checklist da Fase 4
Itens Obrigatórios: - [ ] Monitoramento da Saúde da Aplicação: Saúde da infraestrutura e da aplicação monitorada (CPU, memória, latência, erros)? - [ ] Monitoramento da Qualidade da IA: Performance do componente de IA monitorada em produção (drift, alucinações, sucesso do Copilot)? - [ ] Plano de Sustentação e Melhoria: Plano para corrigir bugs, fazer melhorias e retreinar modelos (se aplicável) definido?
Itens Recomendados: - [ ] Dashboard de Acompanhamento de KPIs: Dashboard criado para stakeholders acompanharem o impacto nos KPIs de negócio? - [ ] Mecanismo de Coleta de Feedback do Usuário: Processo para coletar, analisar e priorizar feedback dos usuários finais estabelecido?
Seção 4 — Orientações Técnicas
Enquanto a seção de Metodologia descreve "o que" fazemos em cada fase, esta seção foca em "como" implementamos nossas soluções de IA, garantindo que elas sejam robustas, seguras, escaláveis e alinhadas às melhores práticas da indústria.
Nossas orientações são baseadas em padrões de engenharia de software aplicados ao universo de Machine Learning e IA Generativa. Elas são o núcleo da nossa promessa de entregar soluções de nível de produção.
4.1 4.1 Padrões de MLOps e LLMOps
MLOps (Machine Learning Operations) e seu derivado para modelos de linguagem, LLMOps, são a espinha dorsal de nossas implementações de IA de nível de produção. O objetivo é aplicar os princípios de DevOps ao ciclo de vida de modelos de IA, trazendo automação, repetibilidade e governança.
4.1.1 4.1.1 Versionamento Unificado
Em projetos de IA, não basta versionar o código. Um modelo é o resultado de código, dados e configuração. Portanto, nosso padrão de versionamento exige:
- Versionamento de Código (Git): Todo o código-fonte, incluindo scripts de treino, pré-processamento e APIs, é versionado no Git.
- Versionamento de Dados (DVC, Lakehouse): Os conjuntos de dados de treino, teste e validação são versionados. Ferramentas como DVC (Data Version Control) ou o time travel de plataformas como Databricks/Snowflake são usadas para garantir que possamos reconstruir um modelo com os dados exatos com os quais ele foi treinado.
- Versionamento de Modelos (Model Registry): Os artefatos de modelo treinados são armazenados em um "Model Registry" (ex: MLflow, Azure ML Registry), que versiona o binário do modelo e o associa às versões do código e dos dados que o geraram.
4.1.2 4.1.2 CI/CD para IA (Continuous Integration / Continuous Deployment)
Nossas esteiras de automação (CI/CD) vão além da compilação e do deploy de aplicações tradicionais. Elas orquestram o ciclo de vida completo do modelo.
CI — Integração Contínua: A cada git push, a esteira de CI é acionada para: 1. Linting e Análise Estática: Garantir a qualidade do código. 2. Testes Unitários: Validar a lógica de componentes individuais. 3. (Opcional) Treinamento do Modelo: Em um ambiente de teste, a esteira pode re-treinar o modelo para validar que as mudanças no código não quebraram o processo de treino. 4. Testes de Contrato e Integração: Garantir que as interfaces do modelo (APIs) não foram alteradas de forma inesperada.
CD — Implantação Contínua: Uma vez que um modelo é aprovado (seja por um git tag ou por promoção manual no Model Registry), a esteira de CD é responsável por: 1. Provisionamento de Infraestrutura (IaC): Usar Terraform ou Bicep para criar a infraestrutura de serviço (ex: Azure Machine Learning Endpoint). 2. Deploy do Modelo: Implantar o modelo versionado do Model Registry no ambiente de produção. 3. Testes de Fumaça (Smoke Tests): Realizar testes básicos no endpoint em produção para garantir que ele está respondendo. 4. Implantação Gradual (Canary/Blue-Green): Liberar o novo modelo para uma pequena porcentagem de usuários antes de direcionar 100% do tráfego, monitorando por erros ou degradação de performance.
4.1.3 4.1.3 Monitoramento
Após o deploy, o trabalho não termina. O monitoramento contínuo é essencial para garantir a saúde da solução:
- Monitoramento de Infraestrutura: Uptime, latência, utilização de CPU/GPU.
- Data Drift: Mudanças na distribuição estatística dos dados de entrada, que podem degradar a performance do modelo.
- Model Drift (Concept Drift): Mudanças na relação entre os dados de entrada e a saída esperada, indicando que o modelo não representa mais a realidade.
- Monitoramento de Custo: Acompanhamento dos custos de inferência e infraestrutura para garantir que a solução permaneça dentro do orçamento.
4.2 4.2 Padrões de Arquitetura de Gen AI
Para soluções de IA Generativa, dois padrões de arquitetura principais formam a base da maioria de nossas implementações. A escolha entre eles depende do caso de uso, da necessidade de customização e do volume de dados de domínio disponíveis.
4.2.1 4.2.1 RAG (Retrieval-Augmented Generation)
O RAG é o padrão mais comum e, geralmente, o ponto de partida para aplicações de "chat com seus dados". Ele "aumenta" o conhecimento de um LLM com informações externas e específicas do seu domínio, sem a necessidade de re-treinamento.
Fase de Ingestão (Offline):
- Load & Chunk: Seus documentos (PDFs, DOCs, etc.) são carregados e quebrados em pedaços menores (chunks). A estratégia de "chunking" é crucial para a qualidade do resultado.
- Embedding: Cada "chunk" é transformado em uma representação numérica (um vetor) por um modelo de embedding. Este vetor captura o significado semântico do texto.
- Store: Os vetores e o texto original são armazenados em um Banco de Dados Vetorial (Vector Database), como Azure AI Search, Pinecone ou ChromaDB.
Fase de Inferência (Online/Real-time):
- Query: O usuário faz uma pergunta.
- Embedding da Query: A pergunta do usuário também é transformada em um vetor pelo mesmo modelo de embedding.
- Retrieve (Busca): O sistema busca no Banco de Dados Vetorial os "chunks" de texto cujos vetores são mais próximos (semanticamente similares) ao vetor da pergunta.
- Augment (Aumentar): Os "chunks" recuperados são inseridos no prompt que será enviado ao LLM, junto com a pergunta original do usuário.
- Generate: O LLM gera uma resposta baseada no contexto fornecido, o que reduz drasticamente as "alucinações" e garante que a resposta seja fundamentada nos seus dados.
Quando usar RAG: - Quando você precisa que o LLM responda com base em um corpo de conhecimento específico e mutável (ex: documentos internos, base de conhecimento, etc.). - Quando a rastreabilidade é importante (você pode citar as fontes usadas para a resposta). - Quando você quer evitar o custo e a complexidade de um fine-tuning.
4.2.2 4.2.2 Fine-Tuning (Ajuste Fino)
O Fine-Tuning é o processo de pegar um LLM pré-treinado e continuar seu treinamento em um conjunto de dados menor e específico. O objetivo não é ensinar novo conhecimento ao modelo, mas sim ajustar seu comportamento, estilo ou formato de resposta.
Como Funciona: 1. Preparação do Dataset: Você cria um conjunto de dados de alta qualidade no formato de pares prompt/resposta_ideal. 2. Processo de Treinamento: Você utiliza a API de um provedor de modelos (como Azure OpenAI ou Google Vertex AI) ou frameworks de código aberto (como a biblioteca transformers da Hugging Face) para executar o processo de fine-tuning. 3. Deploy e Inferência: Você faz o deploy deste novo modelo customizado e o utiliza para inferência.
Quando usar Fine-Tuning: - Para adaptar o estilo, tom ou formato de um modelo. (Ex: "Quero que o modelo sempre responda em formato JSON"). - Para ensinar ao modelo uma nova habilidade ou tarefa que é difícil de explicar em um prompt. - NÃO é a melhor abordagem para injetar conhecimento factual. Para isso, RAG é mais eficiente e escalável.
4.2.3 4.2.3 RAG vs. Fine-Tuning — Qual Escolher?
| Característica | RAG | Fine-Tuning |
|---|---|---|
| Objetivo Principal | Ensinar conhecimento ao modelo | Ensinar comportamento/estilo ao modelo |
| Dados Necessários | Documentos brutos (PDFs, etc.) | Pares de prompt/resposta de alta qualidade |
| Custo | Mais barato (armazenamento e busca) | Mais caro (custo de treinamento de GPU) |
| Atualização | Fácil (basta atualizar a base de dados) | Difícil (requer re-treinamento completo) |
| Rastreabilidade | Alta (pode citar as fontes) | Baixa (o conhecimento é assado no modelo) |
Regra geral: Comece sempre com RAG. Se, e somente se, o RAG não for suficiente para atingir o comportamento desejado, considere adicionar o Fine-Tuning como uma otimização. Muitas vezes, a melhor solução é uma combinação de ambos.
4.3 4.3 Segurança e Testes Específicos de IA
A introdução de sistemas de IA, especialmente os baseados em LLMs, cria novas superfícies de ataque que não existem em aplicações tradicionais. Nossa metodologia incorpora uma abordagem de "segurança desde o design" (security-by-design) para mitigar esses riscos.
4.3.1 4.3.1 Novas Vulnerabilidades em Sistemas de IA
- Injeção de Prompt (Prompt Injection): Esta é a vulnerabilidade mais crítica e comum. Ocorre quando um usuário malicioso insere instruções no prompt que subvertem as instruções originais do sistema.
- Vazamento de Dados Sensíveis (Data Leakage): O LLM pode, inadvertidamente, revelar informações sensíveis que foram incluídas em seu contexto (via RAG) ou em seus dados de treinamento.
- Ataques de Negação de Serviço (DoS): Usuários podem criar prompts complexos e recursivos que consomem uma quantidade excessiva de recursos computacionais (tokens), levando a custos altos ou à indisponibilidade do serviço.
- Geração de Conteúdo Nocivo: O modelo pode ser manipulado para gerar desinformação, discurso de ódio ou outro conteúdo inseguro.
4.3.2 4.3.2 Nossa Estratégia de Defesa
Nossa abordagem de segurança em IA é proativa e baseada em múltiplas camadas de defesa.
Red Teaming para IA: O "Red Teaming" é um processo de teste de segurança adversário, onde uma equipe ("time vermelho") simula ataques para encontrar vulnerabilidades antes que atores maliciosos o façam. Nossos especialistas em segurança de IA tentam ativamente "quebrar" o sistema de IA, utilizando uma vasta gama de técnicas de injeção de prompt, tentando extrair dados sensíveis e testando os limites dos filtros de segurança. O objetivo é identificar as fraquezas no prompt do sistema, nas configurações dos modelos e no fluxo de dados, para que possam ser corrigidas antes do deploy.
Validação e Sanitização de Entradas e Saídas: Sanitização de Entradas — nunca confiamos diretamente na entrada do usuário. Implementamos camadas de validação para detectar e neutralizar padrões maliciosos conhecidos antes que eles cheguem ao LLM. Monitoramento de Saídas — a resposta do LLM também é monitorada. Filtros são aplicados para garantir que o modelo não esteja gerando conteúdo nocivo ou vazando informações que se pareçam com dados sensíveis (ex: números de cartão de crédito, CPFs).
Técnicas de Prompt Engineering para Segurança: - Instruções Claras: O prompt do sistema deve ser extremamente claro sobre o que o modelo pode e, mais importante, o que ele não pode fazer. - Delimitadores: Usamos delimitadores para separar claramente as instruções do sistema dos dados fornecidos pelo usuário. - "Instruction Priming": Repetimos as instruções de segurança mais críticas no final do prompt para reforçar seu comportamento esperado.
Ciclo de Vida de Segurança Contínua: A segurança de IA não é um evento único, mas um ciclo contínuo: Testar → Corrigir → Monitorar → Adaptar.
4.4 4.4 Governança de Segredos e Chaves
Em projetos de IA, a gestão segura de "segredos" — como chaves de API e tokens de autenticação — é de importância crítica.
4.4.1 4.4.1 O Princípio: Nunca Armazene Segredos em Código
A regra fundamental é: segredos nunca devem ser armazenados diretamente no código-fonte ou em arquivos de configuração versionados no Git.
4.4.2 4.4.2 Padrão de Arquitetura — O Cofre de Segredos (Secrets Vault)
A melhor prática é centralizar a gestão de segredos em um serviço especializado (ex: Azure Key Vault, AWS Secrets Manager, HashiCorp Vault).
Fluxo de Acesso Seguro em Aplicações de IA:
- Identidade Gerenciada: A aplicação recebe uma "identidade" do provedor de nuvem.
- Política de Acesso: No Cofre, a identidade da aplicação recebe permissão para LER segredos específicos.
- Recuperação em Tempo de Execução: A aplicação se autentica usando sua identidade, solicita o segredo e o recebe em memória.
- Uso em Memória: O segredo é usado para se conectar ao serviço de IA e nunca é escrito em disco ou em logs.
Benefícios desta Abordagem: Zero Segredos no Código; Gestão Centralizada; Segurança Máxima.
4.5 4.5 Fichas de Modelo (Model Cards) e Rastreabilidade
Uma parte fundamental do nosso pilar de IA Responsável é a documentação transparente de cada modelo. A "Ficha de Modelo" (Model Card) é o nosso artefato padrão para isso.
4.5.1 4.5.1 O que é uma Ficha de Modelo?
É um "documento de identidade" para um modelo de IA, que fornece informações claras sobre seu treino, performance, limitações e uso pretendido.
4.5.2 4.5.2 Por que é Essencial?
- Rastreabilidade e Reprodutibilidade.
- Governança e Conformidade (Compliance).
- Comunicação com Stakeholders.
- Mitigação de Riscos de IA Responsável.
4.5.3 4.5.3 Nossa Estrutura Padrão de Model Card
- Detalhes do Modelo: Nome, versão, tipo, desenvolvedores.
- Uso Pretendido: Caso de uso primário e cenários fora do escopo.
- Dados de Treinamento e Avaliação: Fontes, período, processamento.
- Métricas de Performance: Métricas de avaliação e resultados quantitativos.
- Considerações Éticas e Limitações: Análise de viés, limitações conhecidas.
- Rastreabilidade: Links para o código-fonte, dados e ambiente.
Este artefato é gerado ao final da Fase 3 (Implementação) e é mantido e atualizado durante a Fase 4 (Operação).
Seção 5 — Governança e Métricas
Esta seção detalha o framework de governança contínua que aplicamos durante o Ciclo Operacional. O objetivo é garantir que as soluções de IA em produção permaneçam alinhadas com os objetivos de negócio, dentro dos SLOs técnicos e em conformidade com os princípios de IA Responsável (RAI).
5.1 5.1 Métricas de Desempenho (Técnicas e de Negócio)
Definimos o sucesso através de um painel de métricas que conecta o desempenho técnico ao valor de negócio. Estes indicadores são a base para nossos dashboards de monitoramento.
5.1.1 5.1.1 Métricas de Negócio (KPIs)
Essas métricas medem o impacto da solução de IA nos objetivos de negócio. Elas respondem à pergunta: "Por que estamos fazendo isso?".
| Categoria | Descrição | Exemplos de KPIs |
|---|---|---|
| Eficiência | Otimização de processos e redução de tempo | Redução do TMA; Automação de tarefas manuais |
| Receita | Impacto direto no crescimento do faturamento | Aumento da taxa de conversão; Aumento do ticket médio |
| Custo | Economia de recursos e otimização de gastos | Redução de custo operacional; Otimização de inventário |
| Adoção | Nível de utilização e engajamento com a solução | Nº de usuários ativos (DAU/MAU); Taxa de adoção pelo time |
5.1.2 5.1.2 Métricas Técnicas (SLOs) — ML Clássico
Medem a qualidade e a performance de modelos de previsão, classificação e outros algoritmos de ML clássico.
| Categoria | Métrica | Descrição |
|---|---|---|
| Qualidade do Modelo | Acurácia, F1-Score | Comparar a performance do modelo em produção com a de validação para detectar Model Drift |
| Qualidade do Modelo | Distribuição de Dados | Monitorar desvios na distribuição dos dados de entrada (Data Drift) |
| Performance Operacional | Latência da Predição (ms) | Medir o tempo de resposta da API, crucial para aplicações em tempo real |
| Performance Operacional | Taxa de Erro | Monitorar o percentual de falhas na API (erros 5xx) que impactam a disponibilidade |
5.1.3 5.1.3 Métricas Técnicas (SLOs) — IA Generativa (GenAI)
Medem a qualidade, custo e segurança de soluções baseadas em LLMs, como RAG e chatbots.
| Categoria | Métrica | Descrição |
|---|---|---|
| Qualidade da Resposta | Aterramento (Grounding) | % de respostas baseadas em fatos do contexto, medindo o nível de alucinação |
| Qualidade da Resposta | Relevância | % de respostas úteis, geralmente aferida por feedback do usuário (polegar para cima/baixo) |
| Qualidade da Resposta | Taxa de Resposta Recusada | % de prompts bloqueados por filtros de segurança (toxicidade, etc.) |
| Performance Operacional | Latência (Time-to-First-Token) | Tempo até o início da resposta, medindo a percepção de velocidade |
| Performance Operacional | Throughput (Tokens/seg) | Velocidade com que a resposta é gerada e exibida para o usuário |
| Custo | Custo por Query ($) | Custo médio de uma interação completa do usuário com o modelo |
| Custo | Custo por Token ($) | Custo de tokens de prompt e completude, para análise de micro-custo |
| Custo | Custo Total por Dia/Usuário ($) | Custo agregado para controle orçamentário e identificação de picos |
5.2 5.2 Cadência de Revisão — QBR (Quarterly Business Review)
A Revisão Trimestral de Negócios (QBR) é a nossa principal cerimônia de governança com o cliente. Ela move a conversa do "técnico" para o "estratégico".
- Propósito: Avaliar o valor de negócio entregue pela solução de IA, revisar custos, performance e decidir os próximos passos estratégicos.
- Frequência: A cada 3 meses (ou outra cadência definida no contrato).
- Participantes do Cliente: Patrocinador Executivo (Sponsor), Dono do Produto, Usuários-Chave.
- Participantes da Consultoria: Líder da Prática de IA, Gerente de Sucesso do Cliente.
Agenda Padrão da QBR
- Revisão do Valor de Negócio: Apresentar o dashboard de KPIs de Negócio. O projeto atingiu as metas de ROI definidas na Fase 1?
- Revisão da Performance Operacional e Custo: Apresentar o dashboard de SLOs técnicos (Latência, Drift, Custo). A solução está estável? Os custos estão dentro do orçamento?
- Revisão de IA Responsável e Segurança: Relatório de incidentes de segurança, problemas de viés detectados ou feedback de usuários sobre respostas problemáticas.
- Feedback do Usuário Final: Apresentar feedback qualitativo dos usuários.
- Roadmap e Próximos Passos: Com base em tudo acima, o que faremos no próximo trimestre? Opções: Manter, Otimizar Custos, Retreinar Modelo, Expandir para um Novo Caso de Uso.
5.3 5.3 Conformidade e IA Responsável (Operacional)
Isto é como garantimos que a solução permaneça segura e ética em produção.
5.3.1 5.3.1 Conformidade Regulatória (LGPD)
- Anonimização de Logs: Garantir que os logs de inferência (perguntas dos usuários, dados de entrada) estejam anonimizados ou tenham um TTL (Time-to-Live) curto para proteger a privacidade.
- Governança de Dados de Treino: Ter processos para lidar com solicitações de "direito ao esquecimento" (LGPD), removendo dados de usuários dos próximos ciclos de retreinamento.
- Auditoria: Manter a Ficha de Modelo (Model Card) atualizada como o principal documento de conformidade para auditorias regulatórias.
5.3.2 5.3.2 IA Responsável (RAI) Operacional
Monitoramento Ativo de Viés: Para modelos de Data Science (ex: crédito, RH), os dashboards DEVEM monitorar se a performance do modelo está degradando para subgrupos específicos (viés de performance).
Monitoramento de Segurança de GenAI: Alertas (em tempo real, se possível) para picos em: Tentativas de Prompt Injection detectadas; Respostas bloqueadas por filtros de toxicidade; Tópicos sensíveis sendo discutidos.
Processo de Escalada e Incidente RAI: O Runbook DEVE conter um capítulo para "Incidentes de IA Responsável". Exemplo — se o modelo vazar dados confidenciais ou gerar conteúdo ilegal: tirar o endpoint do ar (se necessário); escalar para o Líder Técnico e o Comitê de Ética do cliente; analisar a causa raiz (ex: um prompt injection bem-sucedido); aplicar correção (ex: melhorar o prompt de sistema, atualizar filtros); documentar na Ficha de Modelo e no relatório de QBR.
Seção 6 — FinOps
6.1 6.1 Introdução ao FinOps
FinOps é uma disciplina de gestão financeira na nuvem e uma prática cultural que visa maximizar o valor de negócio da nuvem. Ele promove a responsabilidade compartilhada entre equipes de tecnologia, finanças e negócios, permitindo que tomem decisões de investimento baseadas em dados.
6.2 6.2 Princípios Fundamentais do FinOps
Os princípios do FinOps são a base para estabelecer uma cultura de gestão de custos eficaz:
- As equipes precisam colaborar: A colaboração entre equipes de engenharia, finanças, produto e liderança é crucial.
- Todos assumem a responsabilidade por seu uso da nuvem: A responsabilidade pelos custos é descentralizada e cada equipe é responsável por seus gastos.
- Uma equipe centralizada impulsiona o FinOps: Uma equipe dedicada de FinOps ajuda a orientar e facilitar as melhores práticas em toda a organização.
- Relatórios acessíveis e oportunos são essenciais: Os dados de custo e uso devem ser transparentes e estar disponíveis para todas as partes interessadas.
- As decisões são orientadas pelo valor de negócio da nuvem: As otimizações de custo devem ser equilibradas com o desempenho, a qualidade e os objetivos de negócio.
- Aproveite o modelo de custo variável da nuvem: As equipes devem se esforçar para otimizar os custos, aproveitando a elasticidade e os modelos de preços da nuvem.
6.3 6.3 LLMOps: Excelência Operacional para IA Generativa
LLMOps (Operações de Grandes Modelos de Linguagem) é um conjunto de práticas para gerenciar o ciclo de vida de aplicações de IA generativa de forma eficiente e escalável. A integração de LLMOps com FinOps é crucial para garantir a sustentabilidade financeira dos projetos de IA.
6.4 6.4 Modelo de Maturidade LLMOps
O modelo de maturidade LLMOps, proposto pela Azure, orienta as organizações a alcançarem a excelência operacional em IA generativa. Ele equilibra a maturidade da aplicação (sofisticação das técnicas de LLM) com a maturidade operacional (implantação, monitoramento e manutenção sistemática).
6.4.1 6.4.1 Nível 1: Inicial (Initial)
Foco: Exploração básica de LLMs pré-construídos.
Características: Uso de modelos como o GPT-3 para prototipagem rápida, com processos manuais e pouca ou nenhuma automação. A implantação é ad-hoc.
Perspectiva FinOps: Custos são exploratórios e muitas vezes imprevisíveis. O foco está em experimentar e aprender, sem uma otimização de custos rigorosa.
6.4.2 6.4.2 Nível 2: Definido (Defined)
Foco: Construção de soluções mais robustas com engenharia de prompts e talvez alguns modelos de fine-tuning.
Características: Processos de desenvolvimento e implantação mais estruturados. Início da automação de pipelines e versionamento de código e prompts.
Perspectiva FinOps: Começa a haver uma previsibilidade de custos. As equipes começam a monitorar os gastos e a identificar oportunidades básicas de otimização.
6.4.3 6.4.3 Nível 3: Gerenciado (Managed)
Foco: Implementação de sistemas de ponta a ponta com automação e monitoramento contínuos.
Características: Pipelines de CI/CD para modelos e aplicações, monitoramento de desempenho e de desvio de dados (data drift), e estratégias de A/B testing.
Perspectiva FinOps: Gestão de custos proativa. O uso de dashboards de custos é comum, e as equipes otimizam ativamente os recursos, escolhendo os modelos e a infraestrutura mais eficientes em termos de custo-benefício.
6.4.4 6.4.4 Nível 4: Otimizado (Optimized)
Foco: Melhoria contínua e iterativa do sistema com base em feedback em tempo real.
Características: Sistemas totalmente automatizados com auto-recuperação e otimização contínua de modelos (por exemplo, re-treinamento automático). Uso de MLOps avançado para governança e segurança.
Perspectiva FinOps: Os custos são totalmente otimizados e alinhados com o valor de negócio. A alocação de custos é precisa, e as decisões de investimento em IA são baseadas em análises de ROI detalhadas.
A progressão através desses níveis permite que as organizações implementem e escalem aplicações de LLM de forma eficaz, garantindo tanto a sofisticação técnica quanto a sustentabilidade financeira.
Seção 7 — Templates e Artefatos (Seu Toolkit)
Esta seção fornece uma coleção de templates e artefatos para auxiliar no desenvolvimento de projetos de software, garantindo consistência e qualidade.
7.1 7.1 Arquitetura
7.1.1 7.1.1 Architecture Decision Record (ADR)
Um Architecture Decision Record (ADR) é um documento que captura uma decisão arquitetural importante feita ao longo do tempo em um projeto de software.
- Status: Recomendado
- Quando usar: Ao tomar uma decisão de arquitetura significativa que terá impacto no sistema.
Template ADR:
# Título do ADR
- **Status:** Proposto | Aceito | Depreciado | Substituído
- **Data:** YYYY-MM-DD
## Contexto
Descrição do problema ou da força motriz por trás desta decisão.
## Decisão
A mudança que estamos propondo e o raciocínio por trás dela.
## Consequências
O que se torna mais fácil ou mais difícil de fazer por causa dessa mudança.
7.1.2 7.1.2 Diagrama de Arquitetura C4
O modelo C4 para visualização de arquitetura de software fornece um conjunto de abstrações para descrever um sistema de software em diferentes níveis de detalhe.
- Nível 1 — Contexto: Mostra o sistema em escopo e suas relações com usuários e outros sistemas.
- Nível 2 — Contêineres: Decompõe o sistema em contêineres (aplicativos, bancos de dados, etc.).
- Nível 3 — Componentes: Decompõe os contêineres em componentes.
- Nível 4 — Código: Um olhar mais atento sobre os componentes, mostrando como são implementados.
7.2 7.2 Gerenciamento de Projetos
7.2.1 7.2.1 Post-mortem
Um post-mortem é um processo para analisar um incidente (como uma falha de produção) para entender a causa raiz e evitar que aconteça novamente.
- Quando usar: Após a resolução de um incidente significativo.
Template Post-mortem:
# Post-mortem: [Nome do Incidente]
- **Data:** YYYY-MM-DD
- **Autores:** [Nomes]
- **Status:** Rascunho | Em Revisão | Final
## Resumo
Breve descrição do incidente, seu impacto e a duração.
## Linha do Tempo
Uma linha do tempo detalhada dos eventos durante o incidente.
## Causa Raiz
Análise da(s) causa(s) raiz do incidente.
## Ações Corretivas
Lista de ações para prevenir a recorrência do problema.
7.2.2 7.2.2 Request for Comments (RFC)
Um Request for Comments (RFC) é um documento para propor e obter feedback sobre uma mudança técnica ou de processo.
- Quando usar: Ao propor uma nova feature, mudança de arquitetura ou alteração em um processo de equipe.
Template RFC:
# RFC: [Título da Proposta]
- **Status:** Rascunho | Em Discussão | Aprovado | Rejeitado
- **Autor:** [Nome]
- **Data:** YYYY-MM-DD
## Resumo
Uma breve descrição da proposta.
## Motivação
Por que esta mudança é necessária? Qual problema ela resolve?
## Proposta Detalhada
Descrição detalhada da mudança proposta.
## Alternativas Consideradas
Quais outras soluções foram consideradas e por que foram descartadas.
7.3 7.3 Padrões de Repositório e Versionamento (GitHub / Azure DevOps)
Esta seção define os padrões obrigatórios para repositórios de código, aplicados tanto no GitHub quanto no Azure DevOps Repos. Esses padrões são a fonte de verdade usada pela nossa automação de provisionamento de repositórios, que corrige nomes fora do padrão e adiciona o pacote inicial de arquivos automaticamente na criação de um repositório.
7.3.1 7.3.1 Nomenclatura de Repositórios e Projetos
- Nome do Repositório: Deve seguir o padrão
kebab-case— apenas letras minúsculas, números e hífens simples como separador (ex:repo-provisioner,client-onboarding-api). Nomes com espaços, underscores, letras maiúsculas ou acentuação são automaticamente normalizados para este padrão. - Prefixo de Tipo de Projeto: Todo repositório deve indicar seu tipo — IA (e Data Agents) ou Automação — em algum ponto do nome informado (ex:
Chatbot IA Suporte,RPA Automação Financeiro,ia-chatbot-suporte). A automação de provisionamento identifica a palavraiaouautomacao(sem acento, sem diferenciar maiúsculas/minúsculas) onde quer que ela apareça no nome e a move sempre para o prefixo do nome final (ex:ia-chatbot-suporte,automacao-rpa-financeiro), usando esse prefixo para decidir qual scaffold aplicar (Seção 7.3.5). Repositórios em que nenhuma das duas palavras aparece recebem o Scaffold Genérico (Seção 7.3.5.3). - Código do Projeto (Azure DevOps): Deve ser um acrônimo em letras maiúsculas, de 2 a 6 caracteres (ex:
AI,SOLO,MLOPS), usado para agrupar repositórios relacionados a uma mesma iniciativa ou cliente. - Nome da Organização (GitHub): Repositórios no GitHub seguem a mesma convenção
kebab-case, prefixados pelo nome do time ou produto quando aplicável (ex:ai-consulting-playbook).
Regras cadastradas nesta seção
- Nomenclatura de repositorio (empresa-dominio-tipo-projeto-componente) Nomenclatura v3
Estrutura: <empresa>-<dominio>-<tipo>-<projeto>-<componente>. Dominio: ia/aut/data/app/hyb. Tipo: std (oficial)/poc/lab. Componente (opcional quando o repo nao se divide em partes): api/func/agent/web/iac/db/wf. Minusculas, sem acento, hifen entre campos.
7.3.2 7.3.2 Estratégia de Branches
Adotamos o modelo GitHub Flow (trunk-based, simplificado) como padrão para a maioria dos projetos, salvo indicação contrária no desenho da solução:
main: Branch protegida, sempre "deployável". Nenhum commit direto é permitido — toda mudança entra via Pull Request.feature/<descrição-curta>: Para novas funcionalidades (ex:feature/add-rag-endpoint).fix/<descrição-curta>: Para correções de bugs (ex:fix/token-expiration).release/<versão>: Opcional, usada apenas em projetos com ciclos de release formais e necessidade de estabilização antes do deploy.
7.3.3 7.3.3 Políticas de Pull Request e Branch Protection
Independentemente da plataforma, toda branch main deve ter as seguintes políticas ativas:
| Política | GitHub (Branch Protection Rules) | Azure DevOps (Branch Policies) |
|---|---|---|
| Bloquear commit direto | Require a pull request before merging |
Require a minimum number of reviewers |
| Revisão obrigatória | Mínimo de 1 revisor aprovador (CODEOWNERS para áreas críticas) |
Mínimo de 1 revisor obrigatório |
| Build/CI obrigatório | Require status checks to pass |
Build validation vinculado à pipeline de CI |
| Vincular a um work item/issue | Referenciar a issue no PR (ex: Closes #123) |
Require linked work items |
| Histórico linear | Require linear history (squash ou rebase) |
Squash merge como estratégia padrão |
7.3.4 7.3.4 Convenção de Commits Semânticos
Todo commit deve seguir o padrão de Commits Semânticos (ver também Seção 9.4):
<tipo>: <descrição curta no imperativo>
[corpo opcional explicando o porquê]
Tipos permitidos: feat (nova funcionalidade), fix (correção de bug), docs (documentação), chore (manutenção, sem impacto em código de produção), refactor, test.
7.3.5 7.3.5 Estrutura Inicial Obrigatória (Scaffold)
Todo repositório novo deve nascer com um pacote mínimo de arquivos — aplicado automaticamente pela automação de provisionamento. O pacote varia conforme o tipo de projeto, identificado pelo prefixo do nome do repositório (Seção 7.3.1).
7.3.5.1 7.3.5.1 Scaffold — Projetos de IA (prefixo `ia-`)
Além dos arquivos abaixo, todo repositório de IA recebe um placeholder para cada artefato do tipo arquivo listado no Catálogo de Artefatos por Fase (Seção 7.4), já organizados em docs/fase-1-planejamento/, docs/fase-2-execucao/ e docs/fase-3-pos-deploy/.
README.md: Descrição do projeto e próximos passos..gitignore: Exclusões básicas do ambiente (dependências, segredos locais, artefatos de build).docs/adr/TEMPLATE.md: Cópia do Template ADR (Seção 7.1.1), pronto para uso na primeira decisão de arquitetura do projeto.
Regras cadastradas nesta seção
- Scaffold [hyb] — arquivo obrigatório: docs/adr/TEMPLATE.md Arquivo obrigatório de scaffold v2
Repositórios do tipo 'hyb' devem conter 'docs/adr/TEMPLATE.md' desde a criação. - Scaffold [hyb] — arquivo obrigatório: .gitignore Arquivo obrigatório de scaffold v1
Repositórios do tipo 'hyb' devem conter '.gitignore' desde a criação. - Scaffold [hyb] — arquivo obrigatório: README.md Arquivo obrigatório de scaffold v1
Repositórios do tipo 'hyb' devem conter 'README.md' desde a criação. - Scaffold [ia] — arquivo obrigatório: docs/adr/TEMPLATE.md Arquivo obrigatório de scaffold v2
Repositórios do tipo 'ia' devem conter 'docs/adr/TEMPLATE.md' desde a criação. - Scaffold [ia] — arquivo obrigatório: .gitignore Arquivo obrigatório de scaffold v1
Repositórios do tipo 'ia' devem conter '.gitignore' desde a criação. - Scaffold [ia] — arquivo obrigatório: README.md Arquivo obrigatório de scaffold v1
Repositórios do tipo 'ia' devem conter 'README.md' desde a criação.
7.3.5.2 7.3.5.2 Scaffold — Projetos de Automação (prefixo `automacao-`)
Além dos arquivos abaixo, todo repositório de Automação recebe um placeholder para cada artefato do tipo arquivo listado no Catálogo de Artefatos por Fase (Seção 7.5), já organizados em docs/fase-1-planejamento/, docs/fase-2-execucao/ e docs/fase-3-pos-deploy/.
README.md: Descrição do projeto e próximos passos..gitignore: Exclusões básicas do ambiente (dependências, segredos locais, artefatos de build).docs/adr/TEMPLATE.md: Cópia do Template ADR (Seção 7.1.1), pronto para uso na primeira decisão de arquitetura do projeto.
Regras cadastradas nesta seção
- Scaffold [automacao] — arquivo obrigatório: docs/adr/TEMPLATE.md Arquivo obrigatório de scaffold v2
Repositórios do tipo 'automacao' devem conter 'docs/adr/TEMPLATE.md' desde a criação. - Scaffold [automacao] — arquivo obrigatório: .gitignore Arquivo obrigatório de scaffold v1
Repositórios do tipo 'automacao' devem conter '.gitignore' desde a criação. - Scaffold [automacao] — arquivo obrigatório: README.md Arquivo obrigatório de scaffold v1
Repositórios do tipo 'automacao' devem conter 'README.md' desde a criação.
7.3.5.3 7.3.5.3 Scaffold — Genérico (tipo não identificado)
Aplicado quando o nome do repositório não contém a palavra ia nem automacao. Serve como base mínima até o repositório ser renomeado com o tipo correto.
README.md: Descrição do projeto e próximos passos..gitignore: Exclusões básicas do ambiente (dependências, segredos locais, artefatos de build).docs/adr/TEMPLATE.md: Cópia do Template ADR (Seção 7.1.1), pronto para uso na primeira decisão de arquitetura do projeto.
Regras cadastradas nesta seção
- Scaffold [generico] — arquivo obrigatório: docs/adr/TEMPLATE.md Arquivo obrigatório de scaffold v2
Repositórios do tipo 'generico' devem conter 'docs/adr/TEMPLATE.md' desde a criação. - Scaffold [generico] — arquivo obrigatório: .gitignore Arquivo obrigatório de scaffold v1
Repositórios do tipo 'generico' devem conter '.gitignore' desde a criação. - Scaffold [generico] — arquivo obrigatório: README.md Arquivo obrigatório de scaffold v1
Repositórios do tipo 'generico' devem conter 'README.md' desde a criação.
7.4 7.4 Catálogo de Artefatos Obrigatórios por Fase de Projeto (IA / Data Agents)
Esta seção consolida o Catálogo de Artefatos da área de IA (fonte: planilha [PLAYBOOK] - Catálogo de Artefatos.xlsx, aba PROCESSOS_AREA_IA) e é a fonte de verdade usada pela nossa automação de validação de esteira de projetos, que verifica no repositório do Azure DevOps se os artefatos obrigatórios de cada etapa existem antes de liberar a passagem de fase (ex: via branch policy de Build Validation em Pull Requests para main).
7.4.1 7.4.1 Convenção de Pastas
Cada projeto organiza seus artefatos de fase em docs/, seguindo kebab-case (Seção 7.3.1):
docs/fase-1-planejamento/docs/fase-2-execucao/docs/fase-3-pos-deploy/
7.4.2 7.4.2 Tipos de Validação
| Tipo | Como é validado |
|---|---|
arquivo |
Existência do arquivo/pasta no caminho indicado, via API do Azure DevOps. |
work-item |
Existência de um Work Item vinculado no Azure Boards, no estado esperado. |
pull-request |
Validado pelo estado do Pull Request (commit final, revisores aprovadores, merge). |
manual |
Aprovação formal externa (ex: aceite do cliente), registrada como evidência anexada ao Work Item correspondente. |
7.4.3 7.4.3 Fase 1 — Planejar e Validar
| Etapa | Artefato Obrigatório | Caminho / Validação | Tipo | Responsável | Revisor |
|---|---|---|---|---|---|
| 1. Entendimento da proposta do projeto | Termo de Abertura e Proposta Técnica | docs/fase-1-planejamento/termo-de-abertura.md |
arquivo |
GP | QA / Especialista de IA |
| 2. Validação de Acessos | Checklist de Acessos | docs/fase-1-planejamento/checklist-de-acessos.md |
arquivo |
Cliente | GP |
| 3. Definição Técnica da Solução | Pacote de Artefatos da Fase 1 | docs/fase-1-planejamento/definicao-tecnica-da-solucao.md |
arquivo |
QA IA / Especialista de IA | QA IA / Especialista de IA |
| 4. Projeto IA — Análise dos Arquivos Verdade | Arquivos Verdade recebidos via e-mail | docs/fase-1-planejamento/arquivos-verdade/ |
arquivo |
Cliente | QA / Especialista de IA |
| 4.1 Projeto IA — Identificação de Padrões | Matriz de Padrões e Exceções | docs/fase-1-planejamento/matriz-de-padroes-e-excecoes.md |
arquivo |
QA IA | Especialista de IA e Time Técnico |
| 5. Projeto Data Agents — Catálogo de Perguntas Benchmark | Catálogo de Perguntas (Benchmark) | docs/fase-1-planejamento/catalogo-de-perguntas-benchmark.md |
arquivo |
Cliente | QA IA |
| 5.1 Projeto Data Agents — Análise dos Dados Estruturados | Documento de Análise dos Dados Estruturados | docs/fase-1-planejamento/analise-dos-dados-estruturados.md |
arquivo |
Especialista Dados | QA / Especialista de IA |
| 5.2 Projeto Data Agents — Matriz de Regras e Rastreabilidade | Matriz de Regras e Rastreabilidade | docs/fase-1-planejamento/matriz-de-regras-e-rastreabilidade.md |
arquivo |
QA | Especialista Dados |
| 6. Discovery Completo | Documento de Discovery | docs/fase-1-planejamento/discovery.md |
arquivo |
QA | Especialista de IA |
| 7. Validação do Cliente | Ata de Aprovação do Documento de Discovery | docs/fase-1-planejamento/ata-de-aprovacao-discovery.md |
manual |
QA | Cliente |
| 8. Plano de Testes e Catálogo de Casos de Teste | Plano de Testes e Catálogo de Casos de Teste | docs/fase-1-planejamento/plano-de-testes.md |
arquivo |
QA | — |
Regras cadastradas nesta seção
- Artefato obrigatório: Arquivos Verdade recebidos via e-mail Artefato obrigatório por fase v2
Etapa: 4. Projeto IA — Análise dos Arquivos Verdade. Responsável: Cliente. Revisor: QA / Especialista de IA. - Artefato obrigatório: Arquivos Verdade recebidos via e-mail Artefato obrigatório por fase v2
Etapa: 4. Projeto IA — Análise dos Arquivos Verdade. Responsável: Cliente. Revisor: QA / Especialista de IA. - Artefato obrigatório: Catálogo de Perguntas (Benchmark) Artefato obrigatório por fase v2
Etapa: 5. Projeto Data Agents — Catálogo de Perguntas Benchmark. Responsável: Cliente. Revisor: QA IA. - Artefato obrigatório: Catálogo de Perguntas (Benchmark) Artefato obrigatório por fase v2
Etapa: 5. Projeto Data Agents — Catálogo de Perguntas Benchmark. Responsável: Cliente. Revisor: QA IA. - Artefato obrigatório: Checklist de Acessos Artefato obrigatório por fase v2
Etapa: 2. Validação de Acessos. Responsável: Cliente. Revisor: GP. - Artefato obrigatório: Checklist de Acessos Artefato obrigatório por fase v2
Etapa: 2. Validação de Acessos. Responsável: Cliente. Revisor: GP. - Artefato obrigatório: Documento de Análise dos Dados Estruturados Artefato obrigatório por fase v2
Etapa: 5.1 Projeto Data Agents — Análise dos Dados Estruturados. Responsável: Especialista Dados. Revisor: QA / Especialista de IA. - Artefato obrigatório: Documento de Análise dos Dados Estruturados Artefato obrigatório por fase v2
Etapa: 5.1 Projeto Data Agents — Análise dos Dados Estruturados. Responsável: Especialista Dados. Revisor: QA / Especialista de IA. - Artefato obrigatório: Documento de Discovery Artefato obrigatório por fase v2
Etapa: 6. Discovery Completo. Responsável: QA. Revisor: Especialista de IA. - Artefato obrigatório: Documento de Discovery Artefato obrigatório por fase v2
Etapa: 6. Discovery Completo. Responsável: QA. Revisor: Especialista de IA. - Artefato obrigatório: Matriz de Padrões e Exceções Artefato obrigatório por fase v2
Etapa: 4.1 Projeto IA — Identificação de Padrões. Responsável: QA IA. Revisor: Especialista de IA e Time Técnico. - Artefato obrigatório: Matriz de Padrões e Exceções Artefato obrigatório por fase v2
Etapa: 4.1 Projeto IA — Identificação de Padrões. Responsável: QA IA. Revisor: Especialista de IA e Time Técnico. - Artefato obrigatório: Matriz de Regras e Rastreabilidade Artefato obrigatório por fase v2
Etapa: 5.2 Projeto Data Agents — Matriz de Regras e Rastreabilidade. Responsável: QA. Revisor: Especialista Dados. - Artefato obrigatório: Matriz de Regras e Rastreabilidade Artefato obrigatório por fase v2
Etapa: 5.2 Projeto Data Agents — Matriz de Regras e Rastreabilidade. Responsável: QA. Revisor: Especialista Dados. - Artefato obrigatório: Pacote de Artefatos da Fase 1 Artefato obrigatório por fase v2
Etapa: 3. Definição Técnica da Solução. Responsável: QA IA / Especialista de IA. Revisor: QA IA / Especialista de IA. - Artefato obrigatório: Pacote de Artefatos da Fase 1 Artefato obrigatório por fase v2
Etapa: 3. Definição Técnica da Solução. Responsável: QA IA / Especialista de IA. Revisor: QA IA / Especialista de IA. - Artefato obrigatório: Plano de Testes e Catálogo de Casos de Teste Artefato obrigatório por fase v2
Etapa: 8. Plano de Testes e Catálogo de Casos de Teste. Responsável: QA. Revisor: —. - Artefato obrigatório: Plano de Testes e Catálogo de Casos de Teste Artefato obrigatório por fase v2
Etapa: 8. Plano de Testes e Catálogo de Casos de Teste. Responsável: QA. Revisor: —. - Artefato obrigatório: Termo de Abertura e Proposta Técnica Artefato obrigatório por fase v2
Etapa: 1. Entendimento da proposta do projeto. Responsável: GP. Revisor: QA / Especialista de IA. - Artefato obrigatório: Termo de Abertura e Proposta Técnica Artefato obrigatório por fase v2
Etapa: 1. Entendimento da proposta do projeto. Responsável: GP. Revisor: QA / Especialista de IA.
7.4.4 7.4.4 Fase 2 — Executar e Validar
| Etapa | Artefato Obrigatório | Caminho / Validação | Tipo | Responsável | Revisor |
|---|---|---|---|---|---|
| 9. Início do Desenvolvimento | Registro de início do desenvolvimento | Work Item vinculado — "Em Desenvolvimento" | work-item |
Especialista de IA | TL |
| 9.1 Criação da Arquitetura Padrão | Diagrama de Arquitetura | docs/fase-2-execucao/diagrama-de-arquitetura.md |
arquivo |
Especialista de IA | TL |
| 9.2 Padronização da Nomenclatura dos Ambientes | Padrão de Nomenclatura Técnica | docs/fase-2-execucao/padrao-de-nomenclatura.md |
arquivo |
Especialista de IA | TL |
| 9.3 Stacks de IA/Automação e Workloads | Registro da Stack Técnica (Seção 6 — referência) | docs/fase-2-execucao/stack-tecnica.md |
arquivo |
Especialista de IA | TL |
| 9.4 Git Flow | Documento de Git Flow (Seção 7.3.2 — referência) | docs/fase-2-execucao/git-flow.md |
arquivo |
Especialista de IA | TL |
| 9.5 README | README.md | README.md |
arquivo |
Especialista de IA | TL |
| 10. Desenvolvimento Finalizado | Pull Request / Release final | Pull Request mergeado para main |
pull-request |
Especialista de IA | TL |
| 10.1 Documentação Técnica | Documento Técnico da Solução | docs/fase-2-execucao/documentacao-tecnica.md |
arquivo |
Especialista de IA | TL |
| 11. Testes Interno Solo [QA] | Relatório de Testes | docs/fase-2-execucao/relatorio-de-testes.md |
arquivo |
QA IA | — |
| 12. Análise dos Defeitos | Relatório de Defeitos | docs/fase-2-execucao/relatorio-de-defeitos.md |
arquivo |
QA IA e Especialista de IA | TL (se necessário) |
| 13. Estimativa de Correções | Estimativa registrada | Work Item com estimativa preenchida | work-item |
Especialista de IA | TL |
| 14. Documentação de Evidências dos Testes | Relatório de Evidências | docs/fase-2-execucao/relatorio-de-evidencias.md |
arquivo |
QA IA | — |
| 15. Homologação (UAT) | Relatório de Homologação | docs/fase-2-execucao/relatorio-de-homologacao.md |
arquivo |
Cliente / QA | — |
| 16. Análise dos Ajustes Solicitados | Relatório de Melhorias / Oportunidade Evolutiva | docs/fase-2-execucao/relatorio-de-melhorias.md |
arquivo |
QA IA e Especialista de IA | TL (se necessário) |
| 17. Reexecução dos Testes (Retestes) | Atualização do Relatório de Evidências e Testes | docs/fase-2-execucao/relatorio-de-evidencias.md (atualizado) |
arquivo |
QA / Cliente | — |
| 18. GMUD — Aprovação para Produção | GMUD com aceite do cliente | docs/fase-2-execucao/gmud-aprovacao-producao.md |
manual |
Especialista IA e Cliente | — |
| 19. Smoke Test em Produção | Relatório de Validação Pós-Deploy | docs/fase-2-execucao/relatorio-validacao-pos-deploy.md |
arquivo |
QA IA e Especialista de IA | — |
Regras cadastradas nesta seção
- Artefato obrigatório: Atualização do Relatório de Evidências e Testes Artefato obrigatório por fase v2
Etapa: 17. Reexecução dos Testes (Retestes). Responsável: QA / Cliente. Revisor: —. - Artefato obrigatório: Atualização do Relatório de Evidências e Testes Artefato obrigatório por fase v2
Etapa: 17. Reexecução dos Testes (Retestes). Responsável: QA / Cliente. Revisor: —. - Artefato obrigatório: Diagrama de Arquitetura Artefato obrigatório por fase v2
Etapa: 9.1 Criação da Arquitetura Padrão. Responsável: Especialista de IA. Revisor: TL. - Artefato obrigatório: Diagrama de Arquitetura Artefato obrigatório por fase v2
Etapa: 9.1 Criação da Arquitetura Padrão. Responsável: Especialista de IA. Revisor: TL. - Artefato obrigatório: Documento de Git Flow (Seção 7.3.2 — referência) Artefato obrigatório por fase v2
Etapa: 9.4 Git Flow. Responsável: Especialista de IA. Revisor: TL. - Artefato obrigatório: Documento de Git Flow (Seção 7.3.2 — referência) Artefato obrigatório por fase v2
Etapa: 9.4 Git Flow. Responsável: Especialista de IA. Revisor: TL. - Artefato obrigatório: Documento Técnico da Solução Artefato obrigatório por fase v2
Etapa: 10.1 Documentação Técnica. Responsável: Especialista de IA. Revisor: TL. - Artefato obrigatório: Documento Técnico da Solução Artefato obrigatório por fase v2
Etapa: 10.1 Documentação Técnica. Responsável: Especialista de IA. Revisor: TL. - Artefato obrigatório: Padrão de Nomenclatura Técnica Artefato obrigatório por fase v2
Etapa: 9.2 Padronização da Nomenclatura dos Ambientes. Responsável: Especialista de IA. Revisor: TL. - Artefato obrigatório: Padrão de Nomenclatura Técnica Artefato obrigatório por fase v2
Etapa: 9.2 Padronização da Nomenclatura dos Ambientes. Responsável: Especialista de IA. Revisor: TL. - Artefato obrigatório: README.md Artefato obrigatório por fase v1
Etapa: 9.5 README. Responsável: Especialista de IA. Revisor: TL. - Artefato obrigatório: README.md Artefato obrigatório por fase v1
Etapa: 9.5 README. Responsável: Especialista de IA. Revisor: TL. - Artefato obrigatório: Registro da Stack Técnica (Seção 6 — referência) Artefato obrigatório por fase v2
Etapa: 9.3 Stacks de IA/Automação e Workloads. Responsável: Especialista de IA. Revisor: TL. - Artefato obrigatório: Registro da Stack Técnica (Seção 6 — referência) Artefato obrigatório por fase v2
Etapa: 9.3 Stacks de IA/Automação e Workloads. Responsável: Especialista de IA. Revisor: TL. - Artefato obrigatório: Relatório de Defeitos Artefato obrigatório por fase v2
Etapa: 12. Análise dos Defeitos. Responsável: QA IA e Especialista de IA. Revisor: TL (se necessário). - Artefato obrigatório: Relatório de Defeitos Artefato obrigatório por fase v2
Etapa: 12. Análise dos Defeitos. Responsável: QA IA e Especialista de IA. Revisor: TL (se necessário). - Artefato obrigatório: Relatório de Evidências Artefato obrigatório por fase v2
Etapa: 14. Documentação de Evidências dos Testes. Responsável: QA IA. Revisor: —. - Artefato obrigatório: Relatório de Evidências Artefato obrigatório por fase v2
Etapa: 14. Documentação de Evidências dos Testes. Responsável: QA IA. Revisor: —. - Artefato obrigatório: Relatório de Homologação Artefato obrigatório por fase v2
Etapa: 15. Homologação (UAT). Responsável: Cliente / QA. Revisor: —. - Artefato obrigatório: Relatório de Homologação Artefato obrigatório por fase v2
Etapa: 15. Homologação (UAT). Responsável: Cliente / QA. Revisor: —. - Artefato obrigatório: Relatório de Melhorias / Oportunidade Evolutiva Artefato obrigatório por fase v2
Etapa: 16. Análise dos Ajustes Solicitados. Responsável: QA IA e Especialista de IA. Revisor: TL (se necessário). - Artefato obrigatório: Relatório de Melhorias / Oportunidade Evolutiva Artefato obrigatório por fase v2
Etapa: 16. Análise dos Ajustes Solicitados. Responsável: QA IA e Especialista de IA. Revisor: TL (se necessário). - Artefato obrigatório: Relatório de Testes Artefato obrigatório por fase v2
Etapa: 11. Testes Interno Solo [QA]. Responsável: QA IA. Revisor: —. - Artefato obrigatório: Relatório de Testes Artefato obrigatório por fase v2
Etapa: 11. Testes Interno Solo [QA]. Responsável: QA IA. Revisor: —. - Artefato obrigatório: Relatório de Validação Pós-Deploy Artefato obrigatório por fase v2
Etapa: 19. Smoke Test em Produção. Responsável: QA IA e Especialista de IA. Revisor: —. - Artefato obrigatório: Relatório de Validação Pós-Deploy Artefato obrigatório por fase v2
Etapa: 19. Smoke Test em Produção. Responsável: QA IA e Especialista de IA. Revisor: —.
7.4.5 7.4.5 Fase 3 — Pós-Deploy e Melhorias da Garantia
| Etapa | Artefato Obrigatório | Caminho / Validação | Tipo | Responsável | Revisor |
|---|---|---|---|---|---|
| 20. Monitoramento/Acompanhamento Operacional | Relatório de Incidentes | docs/fase-3-pos-deploy/relatorio-de-incidentes.md |
arquivo |
QA / Cliente / Especialista de IA | — |
| 21. Coleta de Métricas de Qualidade | Relatório de Métricas | docs/fase-3-pos-deploy/relatorio-de-metricas.md |
arquivo |
QA IA e Especialista de IA | — |
| 22. Melhoria Contínua (se houver) | Backlog de Melhorias | Work Item(s) no backlog | work-item |
QA IA e Especialista de IA | — |
| 22 (bis). Consolidação da Documentação Final | Documentação Final do Projeto | docs/fase-3-pos-deploy/documentacao-final.md |
arquivo |
QA IA e Especialista de IA | GP |
| 23. Encerramento do Projeto | TEP — Termo de Encerramento do Projeto | docs/fase-3-pos-deploy/termo-de-encerramento-projeto.md |
manual |
GP | Supervisor |
Nota: os caminhos de arquivo e o tipo de validação (
arquivo/work-item/pull-request/manual) foram definidos por esta automação a partir da planilha de origem, que descreve os artefatos e responsáveis mas não define caminhos de repositório. Ajuste esta tabela antes de usá-la como contrato de validação, caso a convenção real do time seja diferente. Artefatos do tipoarquivosão materializados no repositório como uma pasta (nome derivado do caminho indicado, sem a extensão) contendo umREADME.mdinicial — não como um arquivo solto — para comportar múltiplas evidências por etapa (exceto oREADME.mdda raiz do repositório, que permanece um arquivo).
Regras cadastradas nesta seção
- Artefato obrigatório: Documentação Final do Projeto Artefato obrigatório por fase v2
Etapa: 22 (bis). Consolidação da Documentação Final. Responsável: QA IA e Especialista de IA. Revisor: GP. - Artefato obrigatório: Documentação Final do Projeto Artefato obrigatório por fase v2
Etapa: 22 (bis). Consolidação da Documentação Final. Responsável: QA IA e Especialista de IA. Revisor: GP. - Artefato obrigatório: Relatório de Incidentes Artefato obrigatório por fase v2
Etapa: 20. Monitoramento/Acompanhamento Operacional. Responsável: QA / Cliente / Especialista de IA. Revisor: —. - Artefato obrigatório: Relatório de Incidentes Artefato obrigatório por fase v2
Etapa: 20. Monitoramento/Acompanhamento Operacional. Responsável: QA / Cliente / Especialista de IA. Revisor: —. - Artefato obrigatório: Relatório de Métricas Artefato obrigatório por fase v2
Etapa: 21. Coleta de Métricas de Qualidade. Responsável: QA IA e Especialista de IA. Revisor: —. - Artefato obrigatório: Relatório de Métricas Artefato obrigatório por fase v2
Etapa: 21. Coleta de Métricas de Qualidade. Responsável: QA IA e Especialista de IA. Revisor: —.
7.5 7.5 Catálogo de Artefatos Obrigatórios por Fase de Projeto (Automação)
Esta seção consolida o Catálogo de Artefatos da área de Automação (fonte: planilha [PLAYBOOK] - Catálogo de Artefatos.xlsx, aba PROCESSOS_AREA_AUTOMACAO) e é a fonte de verdade usada pela nossa automação de validação de esteira de projetos, no mesmo formato e com a mesma convenção de pastas e tipos de validação definidos nas Seções 7.4.1 e 7.4.2. Só os itens marcados como obrigatórios na planilha de origem entram nesta tabela — itens marcados como não obrigatórios (ex: Diagrama de Arquitetura, Estimativa de Correções) ficam fora do catálogo e não geram regra de validação.
7.5.1 7.5.1 Fase 1 — Planejar e Validar
| Etapa | Artefato Obrigatório | Caminho / Validação | Tipo | Responsável | Revisor |
|---|---|---|---|---|---|
| 1. Entendimento da Proposta do Projeto | Documento de Entendimento da Proposta | docs/fase-1-planejamento/entendimento-da-proposta.md |
arquivo |
GP | Especialista de Automação |
| 2. Validação de Acessos | Checklist ou Matriz de Acessos | docs/fase-1-planejamento/checklist-de-acessos.md |
arquivo |
GP | Especialista de Automação |
| 3. Definição Técnica da Solução | Documento de Definição Técnica da Solução | docs/fase-1-planejamento/definicao-tecnica-da-solucao.md |
arquivo |
Especialista de Automação | Especialista de Automação |
| 4. Fluxograma As Is e To Be | Fluxograma AS IS e TO BE | docs/fase-1-planejamento/fluxograma-as-is-to-be.md |
arquivo |
Especialista de Automação | Especialista de Automação |
| 6. Discovery Completo | Documento de Discovery | docs/fase-1-planejamento/discovery.md |
arquivo |
Especialista de Automação | Especialista de Automação |
| 7. Validação do Cliente | Aprovação Formal | docs/fase-1-planejamento/aprovacao-formal.md |
manual |
Especialista de Automação | Especialista de Automação |
| 8. Roteiro de Testes | Plano de Testes e Matriz de Casos de Teste | docs/fase-1-planejamento/plano-de-testes.md |
arquivo |
QA / Especialista de Automação | Especialista de Automação |
Regras cadastradas nesta seção
- Artefato obrigatório: Checklist ou Matriz de Acessos Artefato obrigatório por fase v2
Etapa: 2. Validação de Acessos. Responsável: GP. Revisor: Especialista de Automação. - Artefato obrigatório: Documento de Definição Técnica da Solução Artefato obrigatório por fase v2
Etapa: 3. Definição Técnica da Solução. Responsável: Especialista de Automação. Revisor: Especialista de Automação. - Artefato obrigatório: Documento de Discovery Artefato obrigatório por fase v2
Etapa: 6. Discovery Completo. Responsável: Especialista de Automação. Revisor: Especialista de Automação. - Artefato obrigatório: Documento de Entendimento da Proposta Artefato obrigatório por fase v2
Etapa: 1. Entendimento da Proposta do Projeto. Responsável: GP. Revisor: Especialista de Automação. - Artefato obrigatório: Documento de Entendimento da Proposta Artefato obrigatório por fase v2
Etapa: 1. Entendimento da Proposta do Projeto. Responsável: GP. Revisor: Especialista de Automação. - Artefato obrigatório: Fluxograma AS IS e TO BE Artefato obrigatório por fase v2
Etapa: 4. Fluxograma As Is e To Be. Responsável: Especialista de Automação. Revisor: Especialista de Automação. - Artefato obrigatório: Fluxograma AS IS e TO BE Artefato obrigatório por fase v2
Etapa: 4. Fluxograma As Is e To Be. Responsável: Especialista de Automação. Revisor: Especialista de Automação. - Artefato obrigatório: Plano de Testes e Matriz de Casos de Teste Artefato obrigatório por fase v2
Etapa: 8. Roteiro de Testes. Responsável: QA / Especialista de Automação. Revisor: Especialista de Automação.
7.5.2 7.5.2 Fase 2 — Executar e Validar
| Etapa | Artefato Obrigatório | Caminho / Validação | Tipo | Responsável | Revisor |
|---|---|---|---|---|---|
| 9. Início do Desenvolvimento | Registro de início do desenvolvimento | Work Item vinculado — "Em Desenvolvimento" | work-item |
Especialista de Automação | TL |
| 9.2 Padronização da Nomenclatura dos Ambientes | Padrão de Nomenclatura Técnica | docs/fase-2-execucao/padrao-de-nomenclatura.md |
arquivo |
Especialista de Automação | TL |
| 9.3 Stacks de Automação e Workloads | Registro da Stack Técnica (Seção 6 — referência) | docs/fase-2-execucao/stack-tecnica.md |
arquivo |
Especialista de Automação e Time Técnico | TL |
| 9.4 Git Flow | Documento de Git Flow (Seção 7.3.2 — referência) | docs/fase-2-execucao/git-flow.md |
arquivo |
Especialista de Automação | TL |
| 9.5 README | README.md | README.md |
arquivo |
Especialista de Automação | TL |
| 10.1 Documentação Técnica | Documento Técnico da Solução | docs/fase-2-execucao/documentacao-tecnica.md |
arquivo |
Especialista de Automação | TL |
| 11. Testes Interno Solo [QA] | Relatório de Testes | docs/fase-2-execucao/relatorio-de-testes.md |
arquivo |
— | — |
| 12. Análise dos Defeitos | Relatório de Defeitos | docs/fase-2-execucao/relatorio-de-defeitos.md |
arquivo |
QA e Especialista de Automação | TL (se necessário) |
| 14. Documentação de Evidências | Relatório de Evidências | docs/fase-2-execucao/relatorio-de-evidencias.md |
arquivo |
— | — |
| 15. Homologação (UAT) | Relatório de Homologação | docs/fase-2-execucao/relatorio-de-homologacao.md |
arquivo |
Cliente | — |
| 16. Análise dos Ajustes Solicitados | Relatório de Melhorias / Oportunidade Evolutiva | docs/fase-2-execucao/relatorio-de-melhorias.md |
arquivo |
Especialista de Automação e Time Técnico | TL (se necessário) |
| 18. GMUD — Aprovação para Produção | GMUD com aceite do Cliente | docs/fase-2-execucao/gmud-aprovacao-producao.md |
manual |
Especialista de Automação e Cliente | — |
Regras cadastradas nesta seção
- Artefato obrigatório: Documento de Git Flow (Seção 7.3.2 — referência) Artefato obrigatório por fase v2
Etapa: 9.4 Git Flow. Responsável: Especialista de Automação. Revisor: TL. - Artefato obrigatório: Documento Técnico da Solução Artefato obrigatório por fase v2
Etapa: 10.1 Documentação Técnica. Responsável: Especialista de Automação. Revisor: TL. - Artefato obrigatório: Padrão de Nomenclatura Técnica Artefato obrigatório por fase v2
Etapa: 9.2 Padronização da Nomenclatura dos Ambientes. Responsável: Especialista de Automação. Revisor: TL. - Artefato obrigatório: README.md Artefato obrigatório por fase v1
Etapa: 9.5 README. Responsável: Especialista de Automação. Revisor: TL. - Artefato obrigatório: Registro da Stack Técnica (Seção 6 — referência) Artefato obrigatório por fase v2
Etapa: 9.3 Stacks de Automação e Workloads. Responsável: Especialista de Automação e Time Técnico. Revisor: TL. - Artefato obrigatório: Relatório de Defeitos Artefato obrigatório por fase v2
Etapa: 12. Análise dos Defeitos. Responsável: QA e Especialista de Automação. Revisor: TL (se necessário). - Artefato obrigatório: Relatório de Evidências Artefato obrigatório por fase v2
Etapa: 14. Documentação de Evidências. Responsável: —. Revisor: —. - Artefato obrigatório: Relatório de Homologação Artefato obrigatório por fase v2
Etapa: 15. Homologação (UAT). Responsável: Cliente. Revisor: —. - Artefato obrigatório: Relatório de Melhorias / Oportunidade Evolutiva Artefato obrigatório por fase v2
Etapa: 16. Análise dos Ajustes Solicitados. Responsável: Especialista de Automação e Time Técnico. Revisor: TL (se necessário). - Artefato obrigatório: Relatório de Testes Artefato obrigatório por fase v2
Etapa: 11. Testes Interno Solo [QA]. Responsável: —. Revisor: —.
7.5.3 7.5.3 Fase 3 — Pós-Deploy e Melhorias da Garantia
| Etapa | Artefato Obrigatório | Caminho / Validação | Tipo | Responsável | Revisor |
|---|---|---|---|---|---|
| 20. Consolidação da Documentação Final | Documentação Final do Projeto | docs/fase-3-pos-deploy/documentacao-final.md |
arquivo |
QA e Especialista de Automação | GP |
| 21. Encerramento do Projeto | TEP — Termo de Encerramento do Projeto | docs/fase-3-pos-deploy/termo-de-encerramento-projeto.md |
manual |
GP | Supervisor |
Nota: assim como na Seção 7.4, os caminhos de arquivo e o tipo de validação foram definidos por esta automação a partir da planilha de origem (aba
PROCESSOS_AREA_AUTOMACAO), que descreve os artefatos e responsáveis mas não define caminhos de repositório — ajuste esta tabela antes de usá-la como contrato de validação, caso a convenção real do time seja diferente. Dois itens da planilha de origem ("Análise dos Defeitos" e "Consolidação da Documentação Final") vieram com Responsável/Revisor referenciando "QA IA"/"Especialista de IA" — aparente resíduo de cópia da aba de IA — e foram normalizados aqui para "QA"/"Especialista de Automação"; confirme com quem preencheu a planilha se a intenção era outra.
Regras cadastradas nesta seção
- Artefato obrigatório: Documentação Final do Projeto Artefato obrigatório por fase v2
Etapa: 20. Consolidação da Documentação Final. Responsável: QA e Especialista de Automação. Revisor: GP.
Seção 8 — Referências
Esta seção contém uma lista de referências, incluindo livros, artigos e ferramentas que são fundamentais para as práticas e metodologias descritas neste Playbook.
8.1 8.1 Livros
- "Designing Data-Intensive Applications" por Martin Kleppmann: Uma referência essencial para entender os fundamentos de sistemas de dados distribuídos.
- "Clean Architecture: A Craftsman's Guide to Software Structure and Design" por Robert C. Martin: Um guia para projetar arquiteturas de software que são robustas, flexíveis e fáceis de manter.
- "The DevOps Handbook" por Gene Kim, Jez Humble, Patrick Debois e John Willis: Descreve as práticas e princípios que impulsionam o movimento DevOps.
- "Cloud FinOps" por J.R. Storment e Mike Fuller: Um guia prático para gerenciar e otimizar os custos na nuvem.
- "AI and Machine Learning for Coders" por Laurence Moroney: Um guia prático para desenvolvedores que desejam começar com IA e Machine Learning.
8.2 8.2 Artigos e Publicações
- Attention Is All You Need: O artigo que introduziu a arquitetura Transformer, fundamental para os modelos de linguagem modernos.
- The C4 model for visualizing software architecture: Uma abordagem para descrever e comunicar a arquitetura de software em diferentes níveis de abstração.
- Google SRE Book: O livro sobre Site Reliability Engineering do Google, que define práticas para criar sistemas escaláveis e confiáveis.
8.3 8.3 Ferramentas e Frameworks
- MkDocs: A ferramenta usada para criar esta documentação. É um gerador de sites estáticos rápido e simples, voltado para a criação de documentação de projetos.
- Material for MkDocs: Um tema para o MkDocs que oferece uma aparência moderna e recursos avançados.
- Terraform: Uma ferramenta de infraestrutura como código (IaC) para provisionar e gerenciar a infraestrutura de nuvem de forma declarativa.
- Docker: Uma plataforma para desenvolver, enviar e executar aplicativos em contêineres.
- Scikit-learn: Uma biblioteca de machine learning em Python com ferramentas simples e eficientes para análise preditiva de dados.
- TensorFlow e PyTorch: As duas principais bibliotecas de deep learning de código aberto.
Seção 9 — Contribuindo
Agradecemos o seu interesse em contribuir para o Playbook IA & Automação! Toda contribuição é bem-vinda, desde a correção de um simples erro de digitação até a adição de novas seções.
9.1 9.1 Como Contribuir
Existem várias maneiras de contribuir para este projeto:
- Reportando Bugs: Se você encontrar um erro na documentação ou um link quebrado, por favor, abra uma issue.
- Sugerindo Melhorias: Se você tem uma ideia para uma nova seção, um novo template ou uma melhoria em um conteúdo existente, abra uma issue para discussão.
- Enviando Alterações: Se você deseja corrigir algo diretamente, pode enviar um Pull Request.
9.2 9.2 Reportando Bugs e Sugerindo Melhorias
A melhor maneira de relatar um bug ou sugerir uma melhoria é através das Issues do repositório no GitHub.
- Verifique as Issues Existentes antes de criar uma nova issue.
- Crie uma Nova Issue com um título claro e descritivo, descrevendo o problema ou a sugestão em detalhes.
- Para bugs, inclua passos para reproduzir o problema.
- Use labels para categorizar a issue (ex: bug, enhancement, documentation).
9.3 9.3 Enviando um Pull Request (PR)
Para contribuir com alterações no código ou na documentação, siga estes passos:
- Faça um Fork do Repositório: Crie uma cópia do repositório na sua própria conta do GitHub.
- Crie uma Nova Branch: A partir da branch main, crie uma nova branch para a sua contribuição.
git checkout -b minha-feature-ou-correcao
- Faça as Suas Alterações: Edite os arquivos necessários. Se estiver adicionando um novo documento, lembre-se de adicioná-lo também ao arquivo mkdocs.yml na seção nav.
- Teste Suas Alterações: Para a documentação, você pode visualizar as alterações localmente executando mkdocs serve.
- Faça o Commit das Suas Alterações: Escreva uma mensagem de commit clara.
git commit -m "feat: Adiciona seção sobre X"
# ou
git commit -m "fix: Corrige erro de digitação em Y"
- Envie as Alterações para o Seu Fork:
git push origin minha-feature-ou-correcao
- Abra um Pull Request: Vá para o repositório original e abra um Pull Request da sua branch para a branch main. Forneça um título e uma descrição claros para o seu PR. Se o seu PR resolve uma issue existente, mencione-a na descrição (ex: Closes #123).
9.4 9.4 Estilo e Padrões
- Linguagem: O conteúdo deve ser escrito em português do Brasil, de forma clara e objetiva.
- Formato: Utilize Markdown para formatar o texto.
- Mensagens de Commit: Siga o padrão de Commits Semânticos.
Documento gerado automaticamente a partir do Playbook IA & Automação — icy-flower-06106480f.3.azurestaticapps.net