Skip to content

Padrões de Escrita

Linguagem

  • Escreva em português brasileiro
  • Use linguagem clara e objetiva
  • Evite jargões desnecessários
  • Seja consistente com termos técnicos

Frontmatter

Campos Obrigatórios

CampoTipoDescrição
idstringIdentificador único (RT001)
titulostringNome descritivo
produtostringSlug do produto
modulostringMódulo/área do sistema
tipoenumfuncional, api, performance, seguranca
prioridadeenumalta, media, baixa
statusenumativo, rascunho, obsoleto
tagsarrayTags para busca
ultima_atualizacaodateData no formato YYYY-MM-DD
autorstringNome do autor
versaostringVersão do documento

Tags Recomendadas

Use tags que ajudem na busca e categorização:

Por funcionalidade:

  • login, cadastro, checkout, pagamento, relatorio

Por tipo de teste:

  • smoke, regressao, integracao, e2e

Por característica:

  • seguranca, performance, acessibilidade

Por criticidade:

  • critico, blocker

Casos de Teste

Estrutura do Caso

markdown
### CT001 - Nome Descritivo

**Objetivo:** Uma frase clara sobre o que está sendo validado.

**Prioridade:** Alta | **Tipo:** Positivo

| Passo | Ação | Resultado Esperado |
|-------|------|-------------------|
| 1 | Verbo no infinitivo | Resultado observável |

**Resultado Esperado Final:** Estado final esperado.

Boas Práticas

  1. Nome do caso - Descreva o que está sendo testado, não como

    • Bom: "Login com credenciais válidas"
    • Ruim: "Preencher email e senha e clicar"
  2. Passos - Comece com verbo no infinitivo

    • Bom: "Acessar", "Preencher", "Clicar", "Verificar"
    • Ruim: "O usuário acessa", "Deve preencher"
  3. Resultado esperado - Seja específico e observável

    • Bom: "Mensagem 'Login realizado' é exibida"
    • Ruim: "Sistema funciona corretamente"
  4. Dados de teste - Use valores concretos

    • Bom: "user@test.com"
    • Ruim: "um email válido"

Prioridades

PrioridadeQuando Usar
AltaFuncionalidades críticas, fluxos principais, smoke tests
MédiaFuncionalidades importantes, cenários alternativos
BaixaEdge cases, cenários raros, melhorias de UX

Tipos de Teste

TipoDescrição
PositivoValida o comportamento esperado (happy path)
NegativoValida tratamento de erros e exceções

Informações para Automação

Sempre inclua quando possível:

  1. Seletores - Preferencialmente data-testid
  2. APIs - Endpoint, método, request e response
  3. Código exemplo - Na stack de automação do produto

Padrão de Seletores

typescript
// Preferência de seletores (do melhor para o pior)
'[data-testid="login-button"]'  // 1. data-testid (ideal)
'#login-button'                  // 2. ID único
'.login-form button[type=submit]' // 3. Combinação de seletores
'button'                         // 4. Tag genérica (evitar)

Versionamento

  • Major (1.0 → 2.0): Mudanças estruturais significativas
  • Minor (1.0 → 1.1): Novos casos de teste, atualizações
  • Patch (1.0.0 → 1.0.1): Correções pequenas (opcional)

Histórico de Alterações

Sempre registre mudanças significativas:

markdown
| Data | Versão | Autor | Descrição |
|------|--------|-------|-----------|
| 2025-01-29 | 1.1 | Nome | Adicionado CT005 para validação de campos |
| 2025-01-15 | 1.0 | Nome | Versão inicial |

Documentação de Testes