Referência
Informações de referência para funções de usuário e práticas recomendadas ao implementar modais de integração.
Funções de Usuário
Os modais de integração exigem atribuições de função específicas para configuração e uso:
| Função | Capacidades |
|---|---|
| administrador | Acesso total para criar, editar e excluir registros de orientação, etapas de orientação e conteúdo de ajuda. Pode configurar scripts de cliente e mecanismos de inicialização. Acesso a todos Serviços de adoção módulos. |
| help_content_admin | Edite o conteúdo de orientação existente sem privilégios administrativos totais. Útil para equipes de gestão de conteúdo que mantêm materiais de integração. |
| Usuário (qualquer função) | Exiba e interaja com modais de integração atribuídos à função deles. Navegue pelas etapas, responda a perguntas e ignore ou conclua modais. |
Práticas recomendadas
Siga estas diretrizes para criar experiências de integração eficazes:
Design de conteúdo
- Manter as etapas focadas: Cada etapa deve abranger um conceito. Limite os modais a no máximo 5-7 etapas para evitar sobrecarregar os usuários.
- Usar linguagem clara: Evite jargões e termos técnicos sem explicação. Escreva para sua persona de usuário menos experiente.
- Forneça contexto visual: Inclua capturas de tela ou imagens anotadas mostrando exatamente onde encontrar recursos. Os usuários aprendem melhor com referências visuais.
- Limpar saída: Sempre forneça um Mais tarde ou Pular opção. Nunca prenda usuários na integração obrigatória que bloqueia trabalhos críticos.
Implementação técnica
- Teste entre temas: Verifique a aparência do modal em temas escuros, claros e corais. As imagens e o texto devem permanecer legíveis em todos os contextos.
- Validar referências sys_id: Ao usar gatilhos programáticos, certifique-se de que o sys_id de orientação esteja correto. As referências inválidas falham silenciosamente sem erros voltados para o usuário.
- Definir funções apropriadas: Corresponda os requisitos de função modal às populações de usuários reais. Funções excessivamente restritas significam que os usuários nunca veem orientação; funções excessivamente permissivas mostram conteúdo irrelevante.
- Usar nomes descritivos: Nomeie registros de orientação e etapas claramente para manutenção. Os futuros administradores devem entender a finalidade sem ler todo o conteúdo.
Manutenção e atualizações
- Revisão trimestral: As atualizações de produtos e mudanças de IU podem tornar o conteúdo de integração desatualizado. Programe revisões regulares para manter a precisão.
- Coletar feedback do usuário: Adicione mecanismos de feedback ou monitore tíquetes do help desk mencionando a integração. Os usuários dirão o que está confuso.
- Conteúdo da versão: Use o. Pedido e. Status campo para gerenciar versões de conteúdo. Mantenha versões de rascunho para teste antes de publicar mudanças.
- Personalizações do documento: Mantenha a documentação externa de scripts de cliente personalizados e mecanismos de inicialização. Os conjuntos de atualizações podem não capturar todas as dependências.