agente documentação
This commit is contained in:
parent
b92dc7b06e
commit
5f11352ab7
11 changed files with 239 additions and 158 deletions
48
DOCUMENTACAO/_templates/_template-fluxo
Normal file
48
DOCUMENTACAO/_templates/_template-fluxo
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
type: template
|
||||
name: _template-fluxo
|
||||
description: Template para mapeamento de jornadas do usuário e fluxos de uso de uma funcionalidade
|
||||
updatedAt: "2026-08-12"
|
||||
---
|
||||
|
||||
# Fluxo: <PREENCHER NOME DO FLUXO>
|
||||
|
||||
## Objetivo do Fluxo
|
||||
<O que o usuário ou sistema deseja alcançar ao completar este fluxo?>
|
||||
|
||||
## Ator(es)
|
||||
<Quem inicia e participa do fluxo?>
|
||||
- [...]
|
||||
|
||||
## Pré-condições
|
||||
<O que precisa ser verdadeiro antes deste fluxo iniciar?>
|
||||
- [...]
|
||||
|
||||
## Fluxo Principal
|
||||
<O caminho feliz, passo a passo em ordem cronológica>
|
||||
1. [...]
|
||||
2. [...]
|
||||
3. [...]
|
||||
|
||||
## Fluxos Alternativos
|
||||
<Caminhos secundários ou desvios do fluxo principal>
|
||||
- **Alternativa A** (Ocorre no passo X se a condição Y for verdadeira):
|
||||
1. [...]
|
||||
2. [...] (retorna ao passo Z do fluxo principal)
|
||||
|
||||
## Tratamento de Erros
|
||||
<Como o fluxo reage a falhas, validações incorretas ou problemas de sistema>
|
||||
- **Erro 1** (Falha no passo X): Ação de mitigação e mensagem apresentada.
|
||||
|
||||
## Regras de Negócio Aplicáveis
|
||||
<Quais regras validam e controlam este fluxo? Referenciar `regras-negocio.md` co-localizado>
|
||||
- Regra X: [...]
|
||||
|
||||
## Telas Envolvidas
|
||||
<Quais telas da UI compõem o fluxo?>
|
||||
- [...]
|
||||
|
||||
## Referências
|
||||
- Especificação: `especificacao.md` (co-localizado)
|
||||
- Regras de negócio: `regras-negocio.md` (co-localizado)
|
||||
- [...]
|
||||
Loading…
Add table
Add a link
Reference in a new issue