Suporte - Documentação do Sistema

O que é

A Documentação do Sistema é o portal interno de ajuda do Viagilize, acessível dentro do admin em /admin/docs. Ela concentra os artigos publicados pela equipe da plataforma, separados por módulo, com busca por palavra-chave, seleção em destaque e lista dos conteúdos atualizados recentemente.

Você geralmente chega aqui quando quer aprender a usar um recurso, quando clica em Documentação no menu fixo do admin ou quando o widget de ajuda contextual não encontra um artigo específico para a tela em que está. Cada artigo abre em uma página dedicada com texto, imagens, vídeos e troubleshooting, além de registrar visualizações e feedback (útil / não útil).

Como usar

1. Abra Documentação no menu lateral do admin (item fixo). A página inicial carrega artigos em destaque, lista de módulos e atualizações recentes.
2. Para procurar por um tema específico, use o card Buscar na documentação... logo abaixo do cabeçalho: digite ao menos 2 caracteres e clique em Buscar. Termos com menos de 2 caracteres redirecionam de volta para a página inicial.
3. Para navegar por área do sistema, clique em um dos cards de Navegue por Módulo (Excursões, Passageiros, Clientes, Reservas, Financeiro, etc.). Cada card mostra o total de artigos publicados naquele módulo.
4. Para abrir um artigo em destaque ou recente, clique no card correspondente em Em Destaque ou na linha em Atualizados Recentemente.
5. Caso a documentação não resolva, use o atalho Precisa de Ajuda? no canto superior direito ou Abrir Ticket de Suporte no bloco final da página para criar um chamado.

Casos especiais

Ajuda contextual em outras telas

Algumas páginas do admin abrem o conteúdo direto via /admin/docs/ajuda-contextual, que recebe a URL atual e devolve o artigo cuja url_relacionada casa com o caminho. O matching tenta primeiro a URL exata, depois padrões com curinga (por exemplo /admin/excursoes/*/passageiros) e, por último, segmentos progressivamente menores. Se nada bater, o widget mostra a mensagem "Nenhum artigo de ajuda encontrado para esta página" e oferece o link para a página inicial da documentação.

Categoria inexistente

Acessar /admin/docs/{categoria} com um módulo que não existe na constante DocumentationArticle::MODULOS retorna 404. Os módulos válidos são os que aparecem em Navegue por Módulo na tela inicial.

Feedback do artigo

Dentro de cada artigo é possível enviar feedback positivo ou negativo, com comentário opcional de até 500 caracteres. O sistema usa a sessão do navegador para evitar feedback duplicado do mesmo usuário no mesmo artigo.

Erros comuns e como resolver

• Busca retorna à página inicial sem mostrar resultados - Causa: o termo digitado tem menos de 2 caracteres. Solução: digitar pelo menos 2 letras antes de clicar em Buscar.
• Cliquei no módulo e veio 404 - Causa: URL digitada à mão com um slug de módulo inválido. Solução: voltar para /admin/docs e usar os cards de Navegue por Módulo.
• Widget de ajuda contextual diz que não há artigo - Causa: ainda não existe artigo cadastrado com url_relacionada correspondente à tela atual. Solução: abrir /admin/docs, buscar pelo tema manualmente ou abrir um ticket pelo botão Precisa de Ajuda?.

Onde encontrar

• URL: /admin/docs
• Caminho no menu: Documentação (item fixo do admin)
• Permissão necessária: nenhuma específica - disponível para qualquer usuário autenticado da sua empresa
• Módulo necessário: nenhum

Veja também

• Suporte - Central de Suporte