Référence
Informations de référence pour les rôles d’utilisateur et les bonnes pratiques lors de l’implémentation de modaux d’intégration.
Rôles d'utilisateur
Les modaux d’intégration nécessitent des affectations de rôles spécifiques pour la configuration et l’utilisation :
| Rôle | Options |
|---|---|
| administrateur | Accès complet pour créer, modifier et supprimer des enregistrements de conseil, des étapes de conseil et du contenu d’aide. Peut configurer les scripts clients et les mécanismes de lancement. Accès à tous les Services d'adoption modules. |
| help_content_admin | Modifiez le contenu des conseils existants sans privilèges administratifs complets. Utile pour les équipes de gestion de contenu qui gèrent les supports d’intégration. |
| Utilisateur (n’importe quel rôle) | Affichez et interagissez avec les modaux d’intégration affectés à leur rôle. Parcourez les étapes, répondez aux questions et ignorez ou remplissez les modaux. |
Bonnes pratiques
Suivez ces directives pour créer des expériences d’intégration efficaces :
Conception de contenu
- Restez concentré sur les étapes : Chaque étape doit couvrir un concept. Limitez les fenêtres modales à 5 à 7 étapes maximum pour éviter de submerger les utilisateurs.
- Utilisez un langage clair : Évitez le jargon et les termes techniques sans explication. Écrivez pour votre profil d’utilisateur le moins expérimenté.
- Fournir un contexte visuel : Incluez des captures d’écran ou des images annotées indiquant exactement où trouver les fonctionnalités. Les utilisateurs apprennent mieux avec des références visuelles.
- Indiquez clairement la sortie : Fournissez toujours une option Plus tard ou Ignorer . Ne piégez jamais les utilisateurs dans une intégration obligatoire qui bloque des tâches critiques.
Mise en œuvre technique
- Testez tous les thèmes : Vérifiez l’apparence des fenêtres modales dans les thèmes foncé, clair et corail. Les images et le texte doivent rester lisibles dans tous les contextes.
- Valider sys_id références : Lorsque vous utilisez des déclencheurs programmatiques, assurez-vous que les sys_id de conseil sont correctes. Les références non valides échouent silencieusement sans erreurs face à l’utilisateur.
- Définissez les rôles appropriés : Faites correspondre les besoins du rôle modal aux populations d’utilisateurs réelles. Des rôles trop restrictifs signifient que les utilisateurs ne voient jamais de conseils ; Les rôles trop permissifs affichent un contenu non pertinent.
- Utilisez des noms descriptifs : Nommez clairement les documents d’orientation et les étapes pour assurer leur maintenabilité. Les futurs administrateurs doivent comprendre l’objectif sans lire tout le contenu.
Maintenance et mises à jour
- Examen trimestriel : Les mises à jour de produits et les changements d’interface utilisateur peuvent rendre le contenu d’intégration obsolète. Planifiez des révisions régulières pour maintenir l’exactitude.
- Recueillez les commentaires des utilisateurs : Ajoutez des mécanismes de commentaires ou surveillez les tickets du support technique mentionnant l’intégration. Les utilisateurs vous diront ce qui est déroutant.
- Contenu de la version : Utilisez les champs Ordre et État pour gérer les versions de contenu. Conservez les versions brouillon à des fins de test avant de publier les modifications.
- Personnalisations du document : Conserver la documentation externe des scripts clients personnalisés et des mécanismes de lancement. Les ensembles de mises à jour peuvent ne pas capturer toutes les dépendances.