Pular para conteúdo

Template: Módulo

Objetivo

Padronizar a documentação de um módulo (app Django) de um produto CoreFlow. Baseado na estrutura real usada nos 7 módulos do CoreFlow CRM (accounts, contas, contatos, leads, oportunidades, atividades, tarefas, anotacoes).

Estrutura de pastas

products/<produto>/03-funcional/modulos/<modulo>/
    README.md            # índice + visão geral do módulo
    cadastro.md           # criação/edição da entidade principal
    fluxo.md               # ciclo de vida / máquina de estados
    eventos.md              # o que dispara e o que o módulo dispara
    regras-negocio.md        # validações e regras específicas
    permissoes.md             # quem pode fazer o quê
    indicadores.md              # métricas/dashboards que o módulo alimenta
    integracoes.md                # dependências de outros módulos/sistemas
    api.md                         # rotas reais (Django URLs e/ou DRF)
    testes.md                       # cobertura de testes real

Subpáginas extras só quando o módulo real tiver a capacidade (ex.: importacao.md/exportacao.md/anexos.md no módulo leads do CRM). Nunca criar uma subpágina para uma capacidade que não existe no código.

README.md do módulo — seções obrigatórias

# <Nome do Módulo> — <uma linha resumindo o domínio>

O app `apps.<modulo>` [o que ele faz, em 1-2 frases, extraído do código real].

## Responsabilidades

- ...

## Modelos

| Model | Campos principais |
|---|---|
| ... | ... |

## Ver também

- [Cadastro](cadastro.md) · [Fluxo](fluxo.md) · [Regras de Negócio](regras-negocio.md) · ...

Regra de preenchimento

Todo conteúdo vem do código real do app (models.py, views.py, urls.py, forms.py, services.py, tests/) — nunca placeholder genérico. Se uma capacidade não existe no código, a subpágina correspondente não é criada (não criar arquivo vazio "para o futuro").

Referências