Initial commit
This commit is contained in:
+278
@@ -0,0 +1,278 @@
|
||||
# Manual do Responsável
|
||||
|
||||
## Visão Geral
|
||||
|
||||
O painel do responsável permite gerenciar os estudantes vinculados (filhos), acompanhar seu progresso, acessar materiais e gerenciar pagamentos.
|
||||
|
||||
## Acesso
|
||||
|
||||
- **URL**: `/dashboard/guardian`
|
||||
- **Role Necessária**: `parent` ou `guardian`
|
||||
|
||||
---
|
||||
|
||||
## Funcionalidades
|
||||
|
||||
### 1. Dashboard Principal
|
||||
**Rota**: `/dashboard/guardian`
|
||||
|
||||
Visão geral de todos os estudantes vinculados.
|
||||
|
||||
#### Informações Exibidas
|
||||
- Número total de estudantes
|
||||
- Turmas ativas
|
||||
- Total de turmas
|
||||
|
||||
#### Lista de Estudantes
|
||||
Cards com:
|
||||
- Nome do estudante
|
||||
- Nome de usuário
|
||||
- Número de turmas
|
||||
- Link para dashboard individual
|
||||
|
||||
#### Como Testar
|
||||
1. Faça login como responsável
|
||||
2. Acesse `/dashboard/guardian`
|
||||
3. **Esperado**: Ver todos os estudantes vinculados
|
||||
|
||||
---
|
||||
|
||||
### 2. Dashboard Individual do Estudante
|
||||
**Rota**: `/dashboard/guardian/[id]`
|
||||
|
||||
Página dedicada a um estudante específico.
|
||||
|
||||
#### Informações do Estudante
|
||||
- Nome completo
|
||||
- Nome de usuário
|
||||
- Email
|
||||
- Data de nascimento
|
||||
|
||||
#### Turmas Ativas
|
||||
Cards das turmas em que o estudante está matriculado:
|
||||
- Nome da turma
|
||||
- Professores
|
||||
- Horário
|
||||
- Status
|
||||
|
||||
#### Turmas Arquivadas
|
||||
Turmas inativas ou concluídas.
|
||||
|
||||
#### Como Testar
|
||||
1. No dashboard principal, clique em um estudante
|
||||
2. **Esperado**: Ver informações completas do estudante e suas turmas
|
||||
|
||||
---
|
||||
|
||||
### 3. Detalhes da Turma do Estudante
|
||||
**Rota**: `/dashboard/guardian/[id]/class/[classId]`
|
||||
|
||||
Visão detalhada de uma turma específica do estudante.
|
||||
|
||||
#### Informações da Turma
|
||||
- Nome
|
||||
- Professores
|
||||
- Horário e dias
|
||||
- Status
|
||||
|
||||
#### Estatísticas do Estudante
|
||||
- Taxa de presença (%)
|
||||
- Total de aulas
|
||||
- Presentes, atrasados, ausentes
|
||||
|
||||
#### Materiais Disponíveis
|
||||
Arquivos organizados por categoria para download.
|
||||
|
||||
#### Como Testar - Acessar Turma
|
||||
1. No dashboard do estudante, clique em uma turma
|
||||
2. **Esperado**: Ver detalhes da turma e materiais
|
||||
|
||||
#### Como Testar - Baixar Material
|
||||
1. Na seção "Materiais", clique em um arquivo
|
||||
2. **Esperado**: Download iniciado
|
||||
|
||||
---
|
||||
|
||||
### 4. Histórico de Aulas
|
||||
**Rota**: `/dashboard/guardian/[id]/class/[classId]/history`
|
||||
|
||||
Histórico de presença do estudante em uma turma.
|
||||
|
||||
#### Informações por Aula
|
||||
- Data
|
||||
- Conteúdo/tema
|
||||
- Professor
|
||||
- Status de presença do estudante
|
||||
|
||||
#### Status de Presença
|
||||
- `Presente`: Estudante presente
|
||||
- `Atrasado`: Estudante chegou atrasado
|
||||
- `Ausente`: Estudante faltou
|
||||
- `Justificado`: Falta justificada
|
||||
|
||||
#### Como Testar
|
||||
1. Acesse uma turma do estudante
|
||||
2. Clique em "Histórico"
|
||||
3. **Esperado**: Ver todas as aulas com presença do estudante
|
||||
|
||||
---
|
||||
|
||||
### 5. Registrar Novo Estudante
|
||||
**Rota**: `/dashboard/guardian/register-student`
|
||||
|
||||
Formulário para cadastrar um novo estudante vinculado ao responsável.
|
||||
|
||||
#### Campos Obrigatórios
|
||||
- Nome completo
|
||||
- Nome de usuário
|
||||
- Data de nascimento
|
||||
- Senha
|
||||
|
||||
#### Regras
|
||||
- Estudante deve ter menos de 18 anos
|
||||
- Senha deve ter no mínimo 8 caracteres
|
||||
- Estudante é automaticamente vinculado ao responsável
|
||||
|
||||
#### Como Testar
|
||||
1. Acesse `/dashboard/guardian`
|
||||
2. Clique em "Registrar Novo Estudante"
|
||||
3. Preencha todos os campos
|
||||
4. Clique em "Registrar"
|
||||
5. **Esperado**: Estudante criado e vinculado automaticamente
|
||||
|
||||
---
|
||||
|
||||
### 6. Gerenciamento de Pagamentos
|
||||
**Rota**: `/dashboard/guardian/payments`
|
||||
|
||||
Gerenciar pagamentos de todos os estudantes vinculados.
|
||||
|
||||
#### Funcionalidades
|
||||
- Ver obrigações de todos os estudantes
|
||||
- Filtrar por estudante específico
|
||||
- Registrar pagamentos
|
||||
- Fazer upload de comprovantes
|
||||
- Ver histórico completo
|
||||
- Visualizar comprovantes
|
||||
|
||||
#### Como Testar - Registrar Pagamento
|
||||
1. Acesse `/dashboard/guardian/payments`
|
||||
2. Na seção "Obrigações", encontre uma pendente
|
||||
3. Clique para registrar pagamento
|
||||
4. Preencha:
|
||||
- Valor (preenchido automaticamente da obrigação)
|
||||
- Data do pagamento
|
||||
- Método (PIX, transferência, dinheiro, cartão)
|
||||
- Nome do pagador (opcional)
|
||||
- Upload de comprovante (opcional)
|
||||
- Observações (opcional)
|
||||
5. Salve
|
||||
6. **Esperado**: Pagamento registrado com status "pendente"
|
||||
|
||||
#### Abas de Navegação
|
||||
- **Todos**: Ver pagamentos de todos os estudantes
|
||||
- **Por Estudante**: Filtrar por estudante específico
|
||||
|
||||
#### Status de Pagamento
|
||||
- `pending`: Aguardando aprovação
|
||||
- `verified`: Pagamento aprovado
|
||||
- `rejected`: Pagamento rejeitado
|
||||
|
||||
#### Métodos de Pagamento
|
||||
- `pix`: PIX
|
||||
- `transferência`: Transferência bancária
|
||||
- `dinheiro`: Dinheiro
|
||||
- `cartão_crédito`: Cartão de crédito
|
||||
- `cartão_débito`: Cartão de débito
|
||||
|
||||
---
|
||||
|
||||
### 7. Registro de Pagamento Específico
|
||||
**Rota**: `/dashboard/guardian/payments/register`
|
||||
|
||||
Formulário para registrar um pagamento a partir de uma obrigação específica.
|
||||
|
||||
#### Diferença para a Página Principal
|
||||
- Campo de valor já vem preenchido
|
||||
- Estudante e turma já estão selecionados
|
||||
- Fluxo mais rápido para pagamentos individuais
|
||||
|
||||
#### Como Testar
|
||||
1. A partir de uma obrigação, clique em registrar
|
||||
2. Preencha os campos restantes
|
||||
3. Salve
|
||||
4. **Esperado**: Pagamento registrado
|
||||
|
||||
---
|
||||
|
||||
## Fluxo de Uso Típico
|
||||
|
||||
### Acompanhamento Diário
|
||||
1. Acesse `/dashboard/guardian`
|
||||
2. Clique em um estudante
|
||||
3. Verifique as turmas e atividades recentes
|
||||
|
||||
### Acompanhamento de Pagamentos
|
||||
1. Acesse `/dashboard/guardian/payments`
|
||||
2. Verifique obrigações pendentes
|
||||
3. Registre os pagamentos feitos
|
||||
4. Aguarde aprovação
|
||||
|
||||
### Acompanhamento Acadêmico
|
||||
1. Acesse um estudante
|
||||
2. Entre em uma turma
|
||||
3. Baixe os materiais para acompanhar
|
||||
4. Verifique o histórico de presença
|
||||
|
||||
---
|
||||
|
||||
## Checklist de Testes
|
||||
|
||||
- [ ] Ver lista de estudantes vinculados
|
||||
- [ ] Acessar dashboard de um estudante
|
||||
- [ ] Ver turmas de um estudante
|
||||
- [ ] Acessar detalhes de uma turma
|
||||
- [ ] Baixar material da turma
|
||||
- [ ] Ver histórico de presença
|
||||
- [ ] Registrar novo estudante
|
||||
- [ ] Registrar pagamento para um estudante
|
||||
- [ ] Ver histórico de pagamentos
|
||||
|
||||
---
|
||||
|
||||
## Possíveis Problemas
|
||||
|
||||
### Não vejo um estudante
|
||||
- **Verifique**: O estudante está vinculado à sua conta?
|
||||
- **Solução**: Entre em contato com o admin
|
||||
|
||||
### Não consigo registrar estudante
|
||||
- **Verifique**: A data de nascimento indica menor de 18 anos?
|
||||
- **Solução**: Estudantes maiores de idade devem se cadastrar sozinhos
|
||||
|
||||
### Pagamento não é aprovado
|
||||
- **Verifique**: O comprovante foi anexado corretamente?
|
||||
- **Solução**: Entre em contato com o admin
|
||||
|
||||
### Não vejo todas as turmas do estudante
|
||||
- **Possível causa**: Algumas turmas podem estar arquivadas
|
||||
- **Solução**: Verifique na seção "Turmas Arquivadas"
|
||||
|
||||
---
|
||||
|
||||
## Relação Responsável-Estudante
|
||||
|
||||
### Como Funciona o Vínculo
|
||||
- Estudantes têm um campo `guardiansAccounts` com IDs dos responsáveis
|
||||
- Responsáveis têm um campo `wardAccounts` com IDs dos estudantes
|
||||
- A relação é bidirecional
|
||||
|
||||
### Criando Vínculo (Admin)
|
||||
1. Acesse `/admin/dashboard/users`
|
||||
2. Edite o estudante
|
||||
3. Selecione o responsável na lista
|
||||
4. Salve
|
||||
|
||||
### Criando Vínculo (Auto-registro)
|
||||
- Ao registrar um estudante pelo dashboard do responsável, o vínculo é automático
|
||||
- Isso só funciona para menores de 18 anos
|
||||
Reference in New Issue
Block a user