Fluxos de Usuário - Archyl Docs

Documente fluxos de usuário e dados pela sua arquitetura para visualizar sequências de interações

Fluxos de Usuário

Os Fluxos de Usuário no Archyl permitem documentar sequências de interações pela sua arquitetura. Visualize como usuários, dados ou requisições se movem pelo seu sistema.

O Que São Fluxos?

Um Fluxo representa uma sequência de etapas pela sua arquitetura:

  • Jornadas de usuário: Login, checkout, cadastro
  • Fluxos de dados: Processamento de pedidos, sincronização de dados
  • Interações de sistema: Chamadas de API, cadeias de eventos
  • Tratamento de erros: Cenários de falha, retentativas

Cada etapa em um fluxo referencia relacionamentos na sua arquitetura, criando uma visão conectada de como as coisas funcionam.

Criando um Fluxo

A Partir da Aba Fluxos

  1. Vá para a aba Fluxos no seu projeto
  2. Clique em Criar Fluxo
  3. Insira um nome e uma descrição
  4. Adicione etapas selecionando relacionamentos
  5. Clique em Salvar

Estrutura do Fluxo

Cada fluxo contém:

Campo Descrição
Nome Nome curto e descritivo (ex.: "Fluxo de Login do Usuário")
Descrição O que este fluxo representa
Etapas Lista ordenada de referências a relacionamentos

Adicionando Etapas

Para cada etapa:

  1. Selecione um relacionamento da sua arquitetura
  2. A etapa mostra origem, destino e rótulo do relacionamento
  3. Arraste para reordenar etapas
  4. Adicione notas para contexto adicional

Visualizando Fluxos

Navegação Passo a Passo

Ao visualizar um fluxo:

  • As etapas são mostradas em ordem
  • A etapa atual é destacada no diagrama
  • Navegue com botões Próximo/Anterior
  • Veja o contexto completo em cada etapa

Reprodução Animada

Clique em Reproduzir para animar pelo fluxo:

  • Progressão automática das etapas
  • Caminho destacado no diagrama
  • Velocidade de reprodução ajustável

Compartilhando Fluxos

Links Públicos de Fluxo

Os Fluxos de Usuário possuem compartilhamento público integrado:

  1. Abra um Fluxo
  2. Clique no ícone Compartilhar
  3. Copie a URL pública
  4. Compartilhe com qualquer pessoa

A visualização pública inclui:

  • Navegação passo a passo
  • Visualização da arquitetura
  • Descrição do fluxo
  • Sem necessidade de autenticação

Incorporando Fluxos

Incorpore fluxos em ferramentas externas:

  • Confluence
  • Notion
  • Sites de documentação
  • Wikis

Boas Práticas

Nomeie Fluxos Claramente

Use nomes orientados à ação:

  • "Cadastro de Usuário"
  • "Processo de Checkout de Pedido"
  • "Fluxo de Reembolso de Pagamento"
  • "Pipeline de Sincronização de Dados"

Mantenha Fluxos Focados

  • Um fluxo por jornada do usuário
  • 5-15 etapas é ideal
  • Divida fluxos complexos em subfluxos
  • Referencie outros fluxos quando necessário

Adicione Contexto

Use descrições para explicar:

  • Por que este fluxo existe
  • Quem o utiliza
  • Quando é acionado
  • Qual é o resultado esperado

Vincule à Documentação

Referencie documentos relacionados:

  • Especificações de API
  • Documentos de requisitos
  • ADRs explicando escolhas de design

Exemplos de Fluxos

Checkout de E-commerce

  1. Usuário -> Serviço de Carrinho: "Ver carrinho"
  2. Serviço de Carrinho -> Inventário: "Verificar disponibilidade"
  3. Usuário -> Serviço de Checkout: "Iniciar checkout"
  4. Serviço de Checkout -> Pagamento: "Processar pagamento"
  5. Pagamento -> Serviço de Pedidos: "Criar pedido"
  6. Serviço de Pedidos -> Notificação: "Enviar confirmação"

Autenticação de API

  1. Cliente -> API Gateway: "Requisição com credenciais"
  2. API Gateway -> Serviço de Auth: "Validar token"
  3. Serviço de Auth -> Banco de Usuários: "Buscar usuário"
  4. Serviço de Auth -> API Gateway: "Retornar claims"
  5. API Gateway -> Backend: "Encaminhar com contexto do usuário"

Próximos Passos