Revisão cruzada com o código fonte
Roteiro granular para ensinar a usar a plataforma
Este material cruza o guia atual com o menu lateral, rotas, permissões, feature flags e componentes do Chatwoot usado na ChatVibe. Ele serve como mapa de treinamento e checklist para transformar o guia interativo em uma documentação completa.
O guia interativo atual continua sendo a referência visual. Esta página mostra o que ainda precisa entrar para que uma pessoa aprenda a operar a plataforma ponto por ponto.
Fontes Lidas
Menu lateral
components-next/sidebar/Sidebar.vue
components-next/sidebar/Sidebar.vue
Fonte principal do que aparece na navegação do usuário.
Rotas do dashboard
routes/dashboard/dashboard.routes.js
routes/dashboard/dashboard.routes.js
Agrega conversas, contatos, empresas, relatórios, campanhas, help center, configurações e Captain.
Permissões e flags
As rotas usam permissões como administrador, agente e permissões específicas, além de flags como CRM, reports, campaigns, help_center, captain e companies.
Traduções pt_BR
Os rótulos de menu, perfil, contato e painel lateral foram conferidos nos arquivos de idioma.
Matriz de Cobertura
| Área | O código mostra | Cobertura atual | Faltas para guia completo |
|---|---|---|---|
| Navegação global | Busca, Caixa de Entrada, Conversas, Captain, Contatos, Empresas, Relatórios, Campanhas, Central de Ajuda, Configurações, Perfil | parcial | Empresas, Campanhas, Central de Ajuda, Captain, Caixa de entrada detalhada |
| Conversas | Todas, Menções, Não atendidas, Participantes, Pastas, Times, Canais, Etiquetas | parcial | Participantes, Pastas/custom views, Canais dinâmicos completos, Etiquetas dinâmicas completas |
| Atendimento | Cabeçalho, status, adiar, pendente, responder, nota privada, macros, dados do contato, atributos, notas, conversas anteriores, participantes | bom | context menu de mensagem, resposta pronta dentro do editor, anexos por tipo, prioridade, delete/mute/transcript quando habilitados |
| Contatos | Todos, Ativos, Segmentos, Marcado com etiqueta, Detalhe, Adicionar, Importar, Exportar, Criar segmento, Excluir segmento, bulk actions | parcial | Segmentos, importação/exportação, ações em massa e validação dos prints em sessão autenticada atual |
| Empresas | Todas as empresas, buscar, ordenar | ausente | Toda a área |
| Relatórios | Visão geral, Conversas, Agentes, Etiquetas, Caixas, Times, CSAT, SLA, Bot, detalhes por entidade | parcial | Visão geral, Bot, detalhes por agente/caixa/time/etiqueta, exportações/filtros granulares |
| Campanhas | Chat ao vivo, SMS, WhatsApp, criar, editar, excluir, empty states | ausente | Toda a área |
| Central de Ajuda | Portais, Artigos, Criar artigo, Editar artigo, Categorias, Localidades, Configurações | ausente | Toda a área |
| Configurações | Conta, Agentes, Times, Atribuição, Caixas, Etiquetas, Atributos, Automação, Robôs, Macros, Respostas, Integrações, Auditoria, Funções, SLA, Segurança, Cobrança | parcial | Atribuição, atributos personalizados, robôs, integrações, segurança/SAML, cobrança, edição pós-criação |
| Perfil | Dados básicos, foto, idioma, tema, assinatura, senha, áudio, notificações, token, MFA | parcial | MFA, token, notificações por evento, áudio e assinatura em detalhe |
| Captain | FAQs, Documentos, Cenários, Playground, Caixas, Ferramentas, Configurações, diretrizes, guardrails | ausente | Toda a área, se feature flag estiver ativa |
Mapa de Menus e Rotas
Esta tabela é o cruzamento ponto a ponto entre sidebar, arquivo de rotas e cobertura do guia atual. Ela deve ser usada como checklist de expansão do guia visual.
| Área | Menu | Rota e caminho | Permissões | Flag | Cobertura | Próximo passo do guia |
|---|---|---|---|---|---|---|
| Caixa de Entrada | Caixa de Entrada | inbox_view /accounts/:accountId/inbox-view | roles + conversation permissions | - | parcial | Detalhar lista, filtro e abertura de notificação |
| Caixa de Entrada | Item aberto | inbox_view_conversation /accounts/:accountId/inbox-view/:type/:id | roles + conversation permissions | - | ausente | Mostrar notificação aberta e retorno para lista |
| Conversas | Todas | home /accounts/:accountId/dashboard | conversation permissions | - | coberto | Aprofundar estados vazios/listas reais |
| Conversas | Conversa direta | inbox_conversation /accounts/:accountId/conversations/:conversation_id | conversation permissions | - | coberto | Manter como base do atendimento |
| Conversas | Canal/Caixa | inbox_dashboard /accounts/:accountId/inbox/:inbox_id | conversation permissions | - | parcial | Capturar múltiplos canais dinâmicos |
| Conversas | Etiqueta | label_conversations /accounts/:accountId/label/:label | conversation permissions | - | parcial | Mostrar etiqueta real e lista filtrada |
| Conversas | Time | team_conversations /accounts/:accountId/team/:teamId | conversation permissions | - | parcial | Mostrar times reais e diferença por equipe |
| Conversas | Pasta/custom view | folder_conversations /accounts/:accountId/custom_view/:id | conversation permissions | - | ausente | Explicar visualizações salvas |
| Conversas | Menções | conversation_mentions /accounts/:accountId/mentions/conversations | conversation permissions | - | coberto | Adicionar exemplo com menção real |
| Conversas | Não atendidas | conversation_unattended /accounts/:accountId/unattended/conversations | conversation permissions | - | coberto | Explicar SLA operacional da primeira resposta |
| Conversas | Participantes | conversation_participating /accounts/:accountId/participating/conversations | conversation permissions | - | ausente | Mostrar quando o usuário participa sem ser responsável |
| Contatos | Todos os Contatos | contacts_dashboard_index /accounts/:accountId/contacts | administrator/agent/contact_manage | CRM | coberto | Aprofundar filtros, bulk e ações |
| Contatos | Segmentos | contacts_dashboard_segments_index /accounts/:accountId/contacts/segments/:segmentId | administrator/agent/contact_manage | CRM | ausente | Criar e navegar segmentos |
| Contatos | Marcado com | contacts_dashboard_labels_index /accounts/:accountId/contacts/labels/:label | administrator/agent/contact_manage | CRM | parcial | Mostrar etiqueta aplicada a contatos |
| Contatos | Ativo | contacts_dashboard_active /accounts/:accountId/contacts/active | administrator/agent/contact_manage | CRM | coberto | Explicar dependência do widget/site |
| Contatos | Detalhe do contato | contacts_edit /accounts/:accountId/contacts/:contactId | administrator/agent/contact_manage | CRM | parcial | Detalhe, histórico, notas, mesclagem e envio foram adicionados; ainda validar em sessão atual |
| Empresas | Todas as empresas | companies_dashboard_index /accounts/:accountId/companies | administrator/agent | COMPANIES + Cloud/Enterprise | ausente | Adicionar módulo de empresas |
| Relatórios | Visão geral | account_overview_reports /accounts/:accountId/reports/overview | administrator/report_manage | REPORTS | ausente | Abrir antes de relatórios específicos |
| Relatórios | Conversas | conversation_reports /accounts/:accountId/reports/conversation | administrator/report_manage | REPORTS | coberto | Detalhar filtros e exportação |
| Relatórios | Agentes | agent_reports_index /accounts/:accountId/reports/agents_overview | administrator/report_manage | REPORTS | coberto | Adicionar detalhe agents/:id |
| Relatórios | Etiquetas | label_reports_index /accounts/:accountId/reports/labels_overview | administrator/report_manage | REPORTS | coberto | Adicionar detalhe labels/:id |
| Relatórios | Caixas | inbox_reports_index /accounts/:accountId/reports/inboxes_overview | administrator/report_manage | REPORTS | coberto | Adicionar detalhe inboxes/:id |
| Relatórios | Times | team_reports_index /accounts/:accountId/reports/teams_overview | administrator/report_manage | REPORTS | coberto | Adicionar detalhe teams/:id |
| Relatórios | CSAT | csat_reports /accounts/:accountId/reports/csat | administrator/report_manage | REPORTS | coberto | Detalhar filtros por nota/agente/time |
| Relatórios | SLA | sla_reports /accounts/:accountId/reports/sla | administrator/report_manage | REPORTS | coberto | Detalhar métricas e violações |
| Relatórios | Bot | bot_reports /accounts/:accountId/reports/bot | administrator/report_manage | REPORTS | ausente | Adicionar quando bots estiverem ativos |
| Campanhas | Chat ao vivo | campaigns_livechat_index /accounts/:accountId/campaigns/live_chat | administrator | CAMPAIGNS | ausente | Criar, editar, excluir e estado vazio |
| Campanhas | SMS | campaigns_sms_index /accounts/:accountId/campaigns/sms | administrator | CAMPAIGNS | ausente | Criar, excluir e requisitos de canal |
| Campanhas | campaigns_whatsapp_index /accounts/:accountId/campaigns/whatsapp | administrator | WHATSAPP_CAMPAIGNS | ausente | Criar, excluir e templates/canal | |
| Central de Ajuda | Artigos | portals_articles_index /accounts/:accountId/portals/:portalSlug/:locale/:categorySlug?/articles/:tab? | administrator/agent/knowledge_base_manage | HELP_CENTER | ausente | Lista, busca, criar, editar e publicar |
| Central de Ajuda | Categorias | portals_categories_index /accounts/:accountId/portals/:portalSlug/:locale/categories | administrator/agent/knowledge_base_manage | HELP_CENTER | ausente | Categorias e artigos por categoria |
| Central de Ajuda | Localidades | portals_locales_index /accounts/:accountId/portals/:portalSlug/locales | administrator/agent/knowledge_base_manage | HELP_CENTER | ausente | Idiomas/localidades do portal |
| Central de Ajuda | Configurações | portals_settings_index /accounts/:accountId/portals/:portalSlug/settings | administrator/agent/knowledge_base_manage | HELP_CENTER | ausente | Configurar portal |
| Configurações | Conta | general_settings_index /accounts/:accountId/settings/general | administrator | - | coberto | Detalhar campos |
| Configurações | Agentes | agent_list /accounts/:accountId/settings/agents/list | administrator | AGENT_MANAGEMENT | coberto | Adicionar edição/remover |
| Configurações | Times | settings_teams_list /accounts/:accountId/settings/teams/list | administrator | TEAM_MANAGEMENT | coberto | Adicionar edição/membros/finalização |
| Configurações | Atribuição | assignment_policy_index /accounts/:accountId/settings/assignment-policy/index | administrator | ASSIGNMENT_V2 | ausente | Políticas de atribuição e capacidade |
| Configurações | Caixas | settings_inbox_list /accounts/:accountId/settings/inboxes/list | administrator | INBOX_MANAGEMENT | coberto | Detalhar canal e abas de edição |
| Configurações | Etiquetas | labels_list /accounts/:accountId/settings/labels/list | administrator | LABELS | coberto | Editar e excluir etiqueta |
| Configurações | Atributos | attributes_list /accounts/:accountId/settings/custom-attributes/list | administrator | CUSTOM_ATTRIBUTES | ausente | Criar atributos de contato/conversa |
| Configurações | Automação | automation_list /accounts/:accountId/settings/automation/list | administrator | AUTOMATIONS | coberto | Detalhar eventos, condições e ações |
| Configurações | Robôs | agent_bots /accounts/:accountId/settings/agent-bots | administrator | AGENT_BOTS | ausente | Criar/editar bot |
| Configurações | Macros | macros_wrapper /accounts/:accountId/settings/macros | roles + conversation permissions | MACROS | coberto | Adicionar edição e uso no atendimento |
| Configurações | Respostas Prontas | canned_list /accounts/:accountId/settings/canned-response/list | roles + conversation permissions | CANNED_RESPONSES | coberto | Adicionar edição e uso no editor |
| Configurações | Integrações | settings_applications /accounts/:accountId/settings/integrations | administrator | INTEGRATIONS | ausente | Apps, dashboard apps, webhooks e conectores |
| Configurações | Auditoria | auditlogs_list /accounts/:accountId/settings/audit-logs/list | administrator | AUDIT_LOGS | coberto | Filtrar e interpretar eventos |
| Configurações | Funções | custom_roles_list /accounts/:accountId/settings/custom-roles/list | administrator | CUSTOM_ROLES | coberto | Editar permissões |
| Configurações | SLA | sla_list /accounts/:accountId/settings/sla/list | administrator | SLA | coberto | Editar/excluir e aplicar política |
| Configurações | Segurança | security_settings_index /accounts/:accountId/settings/security | administrator | SAML | ausente | Configurar SSO/SAML |
| Configurações | Cobrança | billing_settings_index /accounts/:accountId/settings/billing | administrator | plano/instalação | ausente | Documentar se estiver visível na conta |
| Perfil | Perfil | profile_settings_index /accounts/:accountId/profile/settings | administrator/agent/custom_role | - | parcial | Detalhar campos e preferências |
| Perfil | MFA | profile_settings_mfa /accounts/:accountId/profile/mfa | administrator/agent/custom_role | MFA global | ausente | Configurar autenticação multifator |
| Captain | FAQs | captain_assistants_responses_index /accounts/:accountId/captain/:assistantId/faqs | administrator/agent | CAPTAIN | ausente | FAQs e pendentes |
| Captain | Documentos | captain_assistants_documents_index /accounts/:accountId/captain/:assistantId/documents | administrator/agent | CAPTAIN | ausente | Base documental da IA |
| Captain | Cenários | captain_assistants_scenarios_index /accounts/:accountId/captain/:assistantId/scenarios | administrator/agent | CAPTAIN_V2 | ausente | Cenários de IA |
| Captain | Playground | captain_assistants_playground_index /accounts/:accountId/captain/:assistantId/playground | administrator/agent | CAPTAIN | ausente | Testes antes de publicar |
| Captain | Caixas | captain_assistants_inboxes_index /accounts/:accountId/captain/:assistantId/inboxes | administrator/agent | CAPTAIN | ausente | Conectar IA aos canais |
| Captain | Ferramentas | captain_tools_index /accounts/:accountId/captain/:assistantId/tools | administrator/agent | CAPTAIN_V2 | ausente | Ferramentas da IA |
| Captain | Configurações | captain_assistants_settings_index /accounts/:accountId/captain/:assistantId/settings | administrator/agent | CAPTAIN | ausente | Configurações, guardrails e guidelines |
Perfis de Usuário
Agente
Precisa dominar conversas, caixa de entrada, contatos, respostas prontas, macros, perfil, notificações e busca global. Pode ver áreas extras se tiver permissões customizadas.
Administrador
Além do fluxo de agente, precisa dominar configurações, agentes, times, caixas, etiquetas, automações, integrações, relatórios, campanhas e segurança.
Recursos opcionais
Empresas, Help Center, Captain, campanhas WhatsApp, SAML, SLA e papéis personalizados dependem de feature flag, plano ou instalação.
Roteiro Granular
1. Navegação global
- Explicar a estrutura fixa: sidebar, área central, busca global, avatar/perfil e atalhos.
- Ensinar a diferença entre Caixa de Entrada e Conversas: uma é fila/notificações; outra é execução do atendimento.
- Mostrar troca de disponibilidade: online, ocupado/offline e marcação automática de offline.
- Mostrar atalhos de teclado e quando usar Ctrl+K.
- Mostrar encerramento de sessão e troca de tema.
2. Caixa de Entrada
- Mostrar lista vazia e lista com notificações.
- Explicar notificações não lidas, adiadas, lidas e filtros de exibição.
- Mostrar abertura de uma notificação via rota inbox-view/:type/:id.
- Ensinar quando usar Caixa de Entrada antes de entrar na fila de conversas.
3. Conversas e filas
- Cobrir Todas as conversas, Menções, Não atendidas e Participantes.
- Cobrir Pastas, Times, Canais e Etiquetas como visões dinâmicas vindas da sidebar.
- Detalhar filtros: campo, operador, valor, adicionar filtro, limpar e aplicar.
- Detalhar ordenação e prioridade operacional: recentes, antigas, resposta pendente e prioridade.
- Mostrar estado vazio, carregamento e lista com múltiplas conversas.
4. Atendimento dentro da conversa
- Separar cabeçalho, histórico, editor de resposta, editor de nota privada e painel lateral.
- Ensinar status: resolver, reabrir, pendente, adiar e janela de resposta.
- Ensinar atribuição: agente, time e transferência com contexto.
- Ensinar composição: responder, nota privada, anexos, emoji, formatação, respostas prontas, macros e envio.
- Ensinar painel lateral: dados do contato, ações, etiquetas, atributos, notas, conversas anteriores e participantes.
- Adicionar ações de contexto da mensagem quando visíveis: responder trecho, copiar link, traduzir, criar resposta pronta e excluir.
5. Contatos
- Cobrir Todos os Contatos, Ativos, Segmentos e Marcado com etiqueta.
- Mostrar busca, filtros, ordenação, paginação e estados vazios.
- Detalhar Adicionar contato: primeiro nome, sobrenome, e-mail, telefone, cidade, país, biografia, empresa e redes sociais.
- Detalhar importar CSV, exportar CSV, criar segmento e excluir segmento.
- Mostrar ações em massa: selecionar, atribuir etiquetas e excluir selecionados quando disponível.
- Mostrar detalhe do contato: avatar, etiquetas, atributos, histórico, notas, mesclagem, bloquear/desbloquear, enviar mensagem e excluir.
6. Empresas
- Explicar que Empresas aparece quando a feature flag COMPANIES está habilitada.
- Mostrar Todas as empresas, busca, ordenação e paginação.
- Conectar empresas com contatos: empresa como dado cadastral e como critério de organização.
7. Relatórios
- Cobrir Visão geral, Conversas, Agentes, Etiquetas, Caixas de Entrada, Times, CSAT, SLA e Bot.
- Mostrar filtros de período, time, caixa, agente e horário comercial quando disponíveis.
- Mostrar visão de detalhe por agente, caixa, time e etiqueta.
- Explicar leitura de métricas: volume, pendência, resolução, resposta, satisfação e cumprimento de SLA.
- Mostrar download/exportação de relatórios.
8. Campanhas
- Explicar diferença entre campanhas de Chat ao vivo, SMS e WhatsApp.
- Mostrar estado vazio e botão de criação.
- Mostrar criação, edição e exclusão de campanha.
- Explicar que WhatsApp depende da feature flag WHATSAPP_CAMPAIGNS e de caixas/canais compatíveis.
9. Central de Ajuda
- Mostrar portais, criação de portal e seleção de localidade.
- Mostrar artigos: lista, busca, criar artigo, editar artigo, publicar/rascunho quando disponível.
- Mostrar categorias e artigos por categoria.
- Mostrar localidades e configurações do portal.
- Explicar quando agentes podem gerenciar conhecimento pela permissão knowledge_base_manage.
10. Configurações administrativas
- Conta: nome, idioma, parâmetros gerais e impacto de alterações.
- Agentes: convidar, editar função, remover e revisar permissões.
- Times: criar, adicionar agentes, editar membros e finalizar configuração.
- Atribuição: políticas de atribuição e capacidade por agente quando ASSIGNMENT_V2 estiver ativa.
- Caixas de Entrada: lista, criar canal, finalizar configuração, adicionar agentes, editar abas de configuração.
- Etiquetas: criar, editar, cor, padronização e impacto em conversas/contatos/relatórios.
- Atributos personalizados: criar atributos para contato/conversa e explicar uso em filtros e painel lateral.
- Automação: evento, condições, ações, revisão de risco antes de ativar.
- Robôs: criar/editar bot, avatar, webhook/integração e quando usar.
- Macros: criar fluxo, ações, escopo público/privado e uso no atendimento.
- Respostas prontas: atalho, conteúdo e uso no editor.
- Integrações: aplicativos, dashboard apps, webhooks, Slack, Linear, Notion, Shopify e exclusão de integração.
- Auditoria: usuário, ação, data e IP.
- Funções personalizadas: permissões por função e cuidado com acesso administrativo.
- SLA: primeira resposta, próxima resposta, resolução e horário comercial.
- Segurança: SAML/SSO, URL de SSO, Entity ID e certificado.
- Cobrança: disponibilidade depende de instalação/plano.
11. Perfil
- Dados básicos, foto, nome, e-mail e idioma.
- Aparência, tamanho de fonte e tema.
- Assinatura de mensagem e comportamento de envio.
- Troca de senha.
- Alertas de áudio e eventos que disparam alerta.
- Preferências de notificação por e-mail/push: criação, atribuição, menção e nova mensagem.
- Token de acesso e cuidado de segurança.
- MFA: habilitar, configurar, recuperar e desabilitar quando a opção estiver ativa.
12. Captain/IA
- FAQs/respostas: lista, pendentes e gerenciamento.
- Documentos: base de conhecimento usada pela IA.
- Cenários: fluxos ou contextos esperados.
- Playground: testar respostas antes de publicar.
- Caixas de Entrada: conectar Captain a canais específicos.
- Ferramentas, configurações, diretrizes e guardrails.
Checklist de Capturas para a Próxima Versão Visual
| Prioridade | Captura | Motivo |
|---|---|---|
| Alta | Contatos - detalhe completo | É onde ficam histórico, notas, mesclagem, etiquetas e ações críticas. |
| Alta | Conversas - Participantes, Pastas, Canais dinâmicos | São rotas visíveis na sidebar que ainda não aparecem no guia. |
| Alta | Configurações - Integrações e Atributos Personalizados | São áreas administrativas importantes e hoje ausentes. |
| Média | Relatórios - Visão geral, Bot e detalhes por entidade | Fecha a compreensão de indicadores operacionais. |
| Média | Campanhas - Chat ao vivo, SMS e WhatsApp | Área inteira ausente no guia atual. |
| Média | Central de Ajuda | Importante quando a operação usa base de conhecimento. |
| Condicional | Captain | Depende de feature flag e adoção real na conta. |
| Condicional | Empresas | Depende da flag COMPANIES/plano. |
Ordem Recomendada de Expansão
- Fechar agente operacional: Caixa de Entrada, todas as visões de conversa, atendimento, contatos e perfil.
- Fechar administrador básico: agentes, times, caixas, etiquetas, respostas prontas, macros, automações e auditoria.
- Fechar CRM e análise: contatos detalhados, empresas, relatórios completos e exportações.
- Fechar recursos avançados: campanhas, help center, integrações, atributos, segurança, billing e Captain.
Para a versão com prints reais, será necessário entrar em uma sessão autenticada da ChatVibe com permissões de administrador e, idealmente, feature flags habilitadas para Empresas, Campanhas, Help Center e Captain.