Pular para conteúdo

Template: Workflow

Objetivo

Padronizar a documentação de um fluxo/processo de negócio — ciclo de vida de uma entidade, com seus estados e transições reais.


Estrutura

# Fluxo: <Nome do Processo>

## Estados

| Estado | Significado |
|---|---|
| ... | ... |

## Diagrama de estados

​```mermaid
stateDiagram-v2
    [*] --> Estado1
    Estado1 --> Estado2: ação/gatilho real
    Estado2 --> [*]
​```

## Transições

| De | Para | Gatilho | Quem pode | Efeito colateral |
|---|---|---|---|---|
| ... | ... | ... | ... | ... |

## Regras

- Transições bloqueadas e por quê (validação real do código).

## Auditoria

Transições que geram `AuditLog` e o código de ação usado.

Regra de preenchimento

Os estados e transições vêm do services.py/models.py reais (campo de status + métodos de transição), não de um fluxo idealizado. Se uma transição não existe no código (ex.: "reabrir" quando não há esse método), ela não entra no diagrama.


Referências