Como escrever requisitos de software que se conseguem verificar
Um requisito útil explica quem precisa de fazer o quê, em que condições e como se confirma o resultado. Esta descrição permite comparar propostas, implementar o comportamento esperado e aceitar a entrega com critérios claros. Pode começar num documento simples, desde que preserve decisões, versões e exemplos concretos.
No final, consegue:
- Separar objetivo de funcionalidade
- Definir regras e limites
- Relacionar requisitos com testes
Explique o problema e a fronteira da primeira entrega
Comece pelo problema observado, pelas pessoas afetadas e pelo resultado que pretende alcançar. «Precisamos de uma aplicação» descreve uma solução possível; «os pedidos ficam sem responsável quando chegam por canais diferentes» descreve um problema que orienta o projeto. Indique como a situação foi observada e o que ainda está por confirmar.
Delimite a primeira entrega. Num exemplo fictício de assistência técnica, o sistema recebe pedidos, atribui responsáveis e acompanha estados. Faturação e gestão de peças ficam fora dessa fase. A orientação de implementação da Microsoft recomenda explicitar objetivos, âmbito e responsabilidades. Esta fronteira permite avaliar alterações sem tratar cada nova ideia como parte implícita do acordo inicial.
Descreva cenários que alguém consegue executar
Identifique o papel, a tarefa e o motivo. «Como coordenador, quero atribuir um pedido a um técnico para que exista uma pessoa responsável pela intervenção» é um começo. Acrescente o estado inicial, os dados necessários e a saída. O nome de um botão ou de um ecrã não substitui o comportamento do processo.
A documentação Agile do Azure Boards distingue histórias, tarefas e defeitos. Use essa separação sem depender da ferramenta: uma necessidade do utilizador pode gerar várias tarefas de implementação. Mantenha a história compreensível para quem trabalha na operação; detalhes de código podem ficar associados numa nota técnica.
| Elemento | Exemplo fictício preenchido |
|---|---|
| Papel | Coordenador de assistência |
| Pré-condição | Pedido aberto, ainda sem técnico |
| Ação | Selecionar um técnico ativo e confirmar atribuição |
| Resultado | Pedido mostra responsável e regista a alteração |
| Exceção | Técnico inativo não pode receber novos pedidos |
Torne explícitas as regras que alteram o resultado
Liste campos obrigatórios, estados permitidos, permissões e condições de mudança. «Atribuir técnico» levanta questões: quem pode alterar a atribuição? É possível ter dois responsáveis? O que acontece se o técnico sair da equipa? A regra precisa de uma decisão do negócio antes de ser traduzida para o sistema.
Defina termos ambíguos num glossário curto. Um pedido fechado pode significar concluído, cancelado ou recusado; se os três casos precisam de relatórios diferentes, devem ser distinguíveis. Para datas, valores e quantidades, indique unidade e fuso quando relevante. Acrescente exemplos de valor válido, inválido e ausente, sobretudo nos campos importados de outros sistemas.
Escreva o que demonstra que o requisito foi cumprido
Um critério de aceitação descreve um resultado observável. Inclua o percurso esperado e casos em que a operação deve ser recusada. Evite critérios como «funciona corretamente» ou «é intuitivo»: não esclarecem a condição de aprovação. Use dados de teste sem informação pessoal desnecessária.
O plano de testes da Microsoft relaciona requisitos, pré-condições, passos e resultados esperados. Uma forma prática é escrever «dado, quando, então». Se dois utilizadores alterarem o mesmo pedido, defina qual comportamento é aceitável: impedir uma substituição silenciosa, pedir atualização ou aplicar uma regra explícita. A equipa técnica escolhe a implementação capaz de cumprir esse contrato.
Dado um pedido aberto sem responsável,
quando a coordenação escolhe um técnico ativo e confirma,
então o pedido mostra esse técnico e a alteração fica no histórico.
Dado um pedido que outro coordenador acabou de alterar,
quando alguém confirma usando uma versão desatualizada,
então o sistema avisa e não substitui silenciosamente a alteração.Inclua requisitos de qualidade e de operação
Além das funcionalidades, descreva dispositivos, acessibilidade, desempenho, continuidade e suporte. «Rápido» não basta: indique a operação, condições do ensaio, quantidade de dados e medida a observar. Um objetivo de tempo escolhido para o projeto é um critério negociado, não um padrão universal ou uma promessa de resultado antes de testar.
Confirme quem cria utilizadores, recupera acessos, exporta dados e trata incidentes. Identifique integrações, limites conhecidos e ambientes de teste. Se o trabalho depende de rede, defina o comportamento quando a ligação falha. Não peça funcionamento offline sem esclarecer que tarefas ficam disponíveis e como os conflitos serão resolvidos no regresso da ligação.
- Indicar navegadores e equipamentos realmente usados pela equipa.
- Definir perfis de acesso e exemplos de operações proibidas.
- Acordar cópias, recuperação e responsabilidades de manutenção.
- Separar funcionalidades de primeira entrega das melhorias posteriores.
Priorize por necessidade e preserve a ligação aos testes
Classifique requisitos como indispensáveis à operação inicial, importantes ou adiáveis. Justifique a prioridade e as dependências: um relatório pode depender de datas que ainda não são registadas. Uma lista em que tudo é urgente não ajuda a decidir o âmbito quando o prazo ou o investimento são limitados.
Dê um identificador a cada requisito e relacione-o com o teste correspondente. Ao alterar uma regra, registe o motivo, a decisão e os testes afetados. Distinga defeito, esclarecimento e mudança de âmbito. Esta distinção não decide automaticamente condições comerciais; fornece evidência para discutir o que mudou e qual é o impacto.
| Formulação fraca | Como a melhorar |
|---|---|
| Ter relatórios completos | Nomear a decisão, os dados, filtros e cálculo. |
| Permitir editar tudo | Indicar perfis, campos e estados editáveis. |
| Enviar notificações | Definir evento, destinatário, canal e falha. |
| Integrar com qualquer sistema | Identificar sistemas, contratos e operações concretas. |
Use uma ficha por comportamento verificável
Preencha primeiro os requisitos que sustentam o percurso principal. Revise-os com alguém da operação e alguém da implementação. Quando a equipa consegue explicar o cenário e o teste da mesma forma, já existe uma base útil para estimar e construir. Guarde decisões ainda abertas com um responsável e uma data para as resolver.
Ficha para o seu projeto
Ficha de requisito Identificador, título e versão: Problema ou objetivo que resolve: Papel do utilizador e permissões necessárias: Estado inicial e dados de entrada: Ação e resultado esperado: Regras, estados e exceções: Critérios de aceitação e exemplos: Comportamento perante erro ou concorrência: Requisitos de qualidade associados: Dependências e prioridade justificada: Teste associado e evidência esperada: Questões por decidir e responsável: Aprovação e data:
Fontes e critérios
Conteúdo elaborado com apoio de IA e pesquisa em fontes técnicas, com revisão dos exemplos e cálculos aplicáveis. As referências apoiam as decisões do guia; os exemplos identificados como fictícios servem para experimentar o método.