Pular para conteúdo

Template: Tela

Objetivo

Padronizar a documentação de uma tela real da aplicação — o que ela faz, quem pode acessá-la e quais ações estão disponíveis.


Estrutura

# Tela: <Nome>

**Rota:** `/<caminho>/`
**View:** `apps.<modulo>.views.<NomeDaView>`
**Template:** `templates/<modulo>/<arquivo>.html`

## Objetivo da tela

O que o usuário consegue fazer aqui, em 1-2 frases.

## Quem acessa

| Perfil | Acesso |
|---|---|
| ... | Leitura / Escrita / Sem acesso |

## Elementos principais

- Lista/tabela, formulário, filtros, ações em massa — o que existe de fato na tela.

## Ações disponíveis

| Ação | Botão/gatilho | Resultado |
|---|---|---|
| ... | ... | ... |

## Estados da tela

- **Vazio:** o que aparece quando não há dados.
- **Erro:** como erros de validação/servidor são exibidos (padrão Bootstrap do tema ativo).
- **Carregando:** se houver estado assíncrono.

## Telas relacionadas

- [Tela anterior](...) · [Próxima tela no fluxo](...)

Regra de preenchimento

Descrever a tela como ela existe hoje no template/view real — nunca a versão "ideal" ou planejada. Seguir o UI Standard para nomear elementos (ícone + tooltip, sem scroll vertical no container principal).


Referências