Como Documentar

Visão Geral

Este guia explica o processo de criação e manutenção de roteiros de teste.

Estrutura de Arquivos

docs/produtos/[nome-produto]/
├── index.md              # Visão geral do produto
└── roteiros/
    ├── RT001-nome.md     # Roteiro de teste
    ├── RT002-nome.md
    └── ...

Nomenclatura

IDs de Roteiro

• Formato: RT + número sequencial de 3 dígitos
• Exemplo: RT001, RT002, RT015

IDs de Caso de Teste

• Formato: CT + número sequencial de 3 dígitos
• Exemplo: CT001, CT002
• Escopo: Único dentro do roteiro

Nome do Arquivo

• Formato: {ID}-{nome-descritivo}.md
• Usar kebab-case
• Exemplo: RT001-login.md, RT015-checkout-carrinho.md

Processo de Criação

1. Criar o Arquivo

# Copie o template
cp docs/guias/template-roteiro.md docs/produtos/[produto]/roteiros/RT00X-nome.md

2. Preencher Frontmatter

O frontmatter é essencial para busca e integração com IA:

---
id: RT00X
titulo: Nome Descritivo
produto: nome-produto
modulo: nome-modulo
tipo: funcional | api | performance | seguranca
prioridade: alta | media | baixa
status: ativo | rascunho | obsoleto
tags:
  - tag1
  - tag2
ultima_atualizacao: YYYY-MM-DD
autor: Nome
versao: 1.0
---

3. Escrever o Conteúdo

Siga a estrutura do template:

1. Contexto - O que está sendo testado e por quê
2. Pré-condições - O que precisa estar pronto
3. Dados de Teste - Dados necessários para execução
4. Casos de Teste - Os testes em si
5. Informações para Automação - Seletores, APIs, exemplos

4. Atualizar Sidebar

Adicione o novo roteiro em docs/.vitepress/config.ts:

{
  text: 'RT00X - Nome',
  link: '/produtos/[produto]/roteiros/RT00X-nome'
}

5. Atualizar Índice do Produto

Adicione na tabela de roteiros em docs/produtos/[produto]/index.md.

Manutenção

Quando Atualizar

• Mudança no comportamento do sistema
• Novos casos de teste identificados
• Correção de erros
• Atualização de seletores/APIs

Versionamento

• Incremente a versão no frontmatter
• Adicione entrada no histórico de alterações
• Atualize a data de última atualização

Dicas

1. Seja específico - Evite ambiguidades nos passos
2. Use dados reais - Inclua exemplos concretos
3. Pense na automação - Inclua seletores e APIs
4. Mantenha atualizado - Documentação desatualizada é pior que nenhuma
5. Tags úteis - Use tags que façam sentido para busca