Templates para Especificação de Features: O Plano de Implementação Perfeito

Templates para Especificação de Features: O Plano de Implementação Perfeito — aula do módulo Templates de Prompt & OpenCRO, na trilha Governança Ágil com…

Leitura de aproximadamente 4 minutos.

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

Templates para Especificação de Features: O Plano de Implementação Perfeito

O que você vai aprender

1. Por Que Pedidos Informais Geram Códigos Frágeis?

Quando você pede para um assistente de IA criar uma funcionalidade dizendo apenas "adicione uma barra de busca no topo do meu site", o modelo precisa adivinhar dezenas de decisões técnicas que você não especificou:

Sem essas respostas, a IA escolherá o caminho estatisticamente mais comum, que raramente coincide com a necessidade real do seu projeto.

Para eliminar esse ruído, utilizamos um Template de Especificação de Features. O template atua como um formulário padronizado que obriga o desenvolvedor (ou a própria IA em fase de planejamento) a detalhar o plano de voo antes de tocar em qualquer linha de código.

2. A Estrutura Canônica do Plano de Implementação

No desenvolvimento profissional assistido por IA, o documento de especificação (frequentemente salvo como docs/implementation_plan.md ou task.md) possui quatro blocos obrigatórios:


+-------------------------------------------------------------------------------+
|                       ESTRUTURA DO PLANO DE IMPLEMENTAÇÃO                     |
+-------------------------------------------------------------------------------+
|                                                                               |
|   1. OBJETIVO DA FEATURE                                                      |
|      └─ O problema prático resolvido e o resultado esperado.                  |
|                                                                               |
|   2. DECISÕES DE USUÁRIO / INTERFACE                                          |
|      └─ Cores, textos dos botões, comportamento mobile e mensagens de erro.   |
|                                                                               |
|   3. ALTERAÇÕES PROPOSTAS POR ARQUIVO                                         |
|      └─ [NOVO] src/busca.js │ [MODIFICAR] src/index.html │ [MANTER] style.css |
|                                                                               |
|   4. PLANO DE VERIFICAÇÃO                                                     |
|      └─ Como testar manualmente e comprovar que a funcionalidade opera 100%.  |
|                                                                               |
+-------------------------------------------------------------------------------+

3. O Template Pronto para Uso

Abaixo está o modelo em Markdown que você pode copiar e colar diretamente no seu projeto sempre que for planejar uma nova funcionalidade:


# Plano de Implementação: [Nome da Funcionalidade]

## 1. Objetivo
Descreva em 2 a 3 frases o que a funcionalidade faz e por que ela é necessária para o usuário final.

## 2. Decisões de Usuário e Interface
- Comportamento visual: (ex.: campo com ícone de lupa e botão azul).
- Estados da tela: (ex.: estado vazio, carregando, resultado encontrado, nenhum resultado).
- Responsividade: (ex.: no celular o campo ocupa 100% da largura).

## 3. Alterações Propostas
- [NOVO] `src/componentes/busca.js` — Lógica de filtro dos itens.
- [MODIFICAR] `src/index.html` — Inserção do formulário de busca no cabeçalho.
- [MODIFICAR] `src/style.css` — Estilos visuais do campo e da lista de resultados.

## 4. Plano de Verificação
1. Abrir `src/index.html` no navegador.
2. Digitar uma palavra existente e conferir se os itens corretos são exibidos.
3. Digitar um termo inexistente e conferir se a mensagem "Nenhum resultado" aparece.
4. Reduzir a janela para o tamanho mobile e checar se o layout permanece alinhado.

4. Comparativo de Produtividade

| Abordagem | Clareza do Resultado | Risco de Retrabalho | Tempo Total até o Deploy | |---|---|---|---| | Pedido Informal no Chat | Baixa (IA adivinha requisitos) | Alto (múltiplas refatorações para consertar premissas falsas) | 2 horas | | Com Template de Especificação | Total (todos os detalhes previstos) | Mínimo (IA executa exatamente o roteiro aprovado) | 20 minutos |

5. Armadilhas Comuns e Como Evitar

[!IMPORTANT]
Permitir que a IA Escreva Código Antes de Você Aprovar o Plano: Quando pedir para a IA planejar uma funcionalidade complexa, use a instrução expressa: "Crie apenas o implementation_plan.md e aguarde minha aprovação antes de criar ou modificar qualquer arquivo de código". Isso permite que você corrija premissas erradas no papel em trinta segundos, em vez de passar uma hora depurando dezenas de arquivos alterados indevidamente.

Exercício Prático

Vamos preencher um template real para adicionar um formulário de captura de e-mails em uma página existente:

1. Crie um arquivo de especificação: No seu projeto, crie o arquivo docs/especificacao-newsletter.md. 2. Preencha os campos com base no cenário:

Outras aulas do módulo