Fluxo de Desenvolvimento Limpo: Ciclo de Especificação, Código e Auditoria

Fluxo de Desenvolvimento Limpo: Ciclo de Especificação, Código e Auditoria — aula do módulo Princípios do Método OKAM, na trilha Governança Ágil com Método…

Leitura de aproximadamente 4 minutos.

Módulo: Princípios do Método OKAM · Curso: Governança Ágil com Método OKAM · Formação: Formação Nível Zero: Ferramentas Essenciais e Gratuitas de IA e Código

Fluxo de Desenvolvimento Limpo: Ciclo de Especificação, Código e Auditoria

O que você vai aprender

1. O Ciclo em Três Etapas do Desenvolvimento Limpo

Construir software com inteligência artificial sem um processo estruturado é como construir uma casa sem planta baixa: as paredes sobem rápido, mas o teto desaba na primeira chuva.

Para transformar o trabalho com IA em um processo profissional e previsível, o método OKAM estrutura o trabalho em um ciclo contínuo de três etapas obrigatórias:


+-------------------------------------------------------------------------------+
|                       O CICLO DE DESENVOLVIMENTO LIMPO OKAM                   |
+-------------------------------------------------------------------------------+
|                                                                               |
|   1. ESPECIFICAÇÃO CLARA        2. GERAÇÃO ASSISTIDA        3. AUDITORIA      |
|   +─────────────────────+       +───────────────────+       +───────────────+ |
|   |  • Define objetivo  |  ──>  |  • IA edita       |  ──>  | • Roda testes | |
|   |  • Lista arquivos   |       |    linhas exatas  |       | • Revisa Diff | |
|   |  • Cria task.md     |       |  • Baixo churn    |       | • Git Commit  | |
|   +─────────────────────+       +───────────────────+       +───────────────+ |
|              ▲                                                      │         |
|              └────────────────── Proxima Tarefa ────────────────────┘         |
|                                                                               |
+-------------------------------------------------------------------------------+

Detalhamento das 3 Etapas

A tabela a seguir apresenta os insumos, as ações práticas e o resultado esperado em cada fase do ciclo:

| Etapa | Responsável Principal | O que acontece | Entregável Concreto | |---|---|---|---| | 1. Especificação | Humano (você) | Redige o objetivo, o escopo máximo e os critérios de aceitação em um arquivo de plano (task.md). | Documento de requisitos claro e conciso. | | 2. Geração | IA assistida | Lê o plano e aplica as alterações apenas nos arquivos autorizados, mantendo o menor churn possível. | Código modificado de forma cirúrgica. | | 3. Auditoria | Humano + Testes | Executa a verificação local no navegador ou terminal, confere o git diff e faz o commit de salvamento. | Código validado e commit registrado no Git. |

2. A Disciplina da Auditoria: Nunca Pule a Verificação

Muitos iniciantes cometem o erro de assumir que, se a IA respondeu com um tom confiante e não exibiu erros no texto, o código gerado está 100% perfeito.

No desenvolvimento profissional, nenhum código é considerado pronto até ser auditado. A etapa de auditoria consiste em três checagens rápidas:

1. Checagem Visual ou de Execução: Abrir a página no navegador ou rodar o script no terminal para ver o resultado com os próprios olhos. 2. **Revisão da Diferença (Git Diff): Executar git diff no terminal para inspecionar cada linha adicionada ou removida. Se a IA modificou algo que não fazia parte do combinado, desfaça antes de prosseguir. 3. Commit Atômico**: Salvar a alteração no Git com uma mensagem descritiva (por exemplo: git commit -m "Adiciona validacao de email no formulario").

3. O Conceito de Commits Atômicos

Um Commit Atômico é um salvamento no Git que contém apenas uma única responsabilidade lógica concluída e testada.

Se você estiver construindo uma página e precisar (1) ajustar as cores do cabeçalho e (2) criar o formulário de contato, nunca faça essas duas tarefas juntas em um único commit gigantesco.

Se o formulário apresentar algum erro no futuro, você poderá reverter apenas o formulário sem perder o cabeçalho perfeito que já havia sido concluído.

4. Armadilhas Comuns e Como Evitar

[!IMPORTANT]
Avançar para a Próxima Tarefa com Débito Técnico Oculto: A tentação de pedir uma nova funcionalidade antes de validar a anterior é o caminho mais rápido para quebrar um projeto. Se uma etapa tiver um defeito escondido e você pedir para a IA construir algo em cima dela, o assistente usará a base defeituosa como premissa, multiplicando os erros. Valide cada passo antes de dar o próximo.

Exercício Prático

Vamos executar o ciclo completo em uma tarefa simples de teste no seu ambiente:

1. Etapa 1 (Especificação): Abra o editor e crie um arquivo chamado task.md com o seguinte conteúdo:


   # Tarefa: Criar Cartão de Perfil em HTML
   - Arquivo alvo: src/card.html
   - Requisito: Exibir nome, profissão e um botão de contato.
   - Proibição: Não use bibliotecas externas nem estilos inline.

2. Etapa 2 (Geração): Peça ao seu assistente de IA:

"Leia o arquivo task.md e crie o arquivo src/card.html atendendo rigorosamente aos requisitos especificados."

3. Etapa 3 (Auditoria e Salvamento):


     git status
     git diff


     git add src/card.html task.md
     git commit -m "Cria componente de cartao de perfil conforme task.md"

Parabéns: você acabou de concluir um ciclo completo de desenvolvimento limpo com governança OKAM.

Outras aulas do módulo