Authentifier
Gérer les utilisateurs
Personnaliser
PlateformeConseils de rédaction pour les guides d’installation
Découvrez les directives de rédaction qu’Auth0 attend pour les guides d’installation des intégrations Marketplace.
Si vous ne pouvez pas consulter un guide de style complet, les conseils suivants vous aideront à améliorer considérablement votre contenu.
Évitez la voix passive (être + participe passé). Pour rendre votre texte plus dynamique, plus clair et (souvent) plus court, essayez d’employer des sujets concrets et la voix active chaque fois que possible.
Lorsque vous créez des liens vers d’autres ressources, assurez-vous que le lien décrit l’action ou la tâche du document vers lequel il renvoie. Un texte de lien générique nuit au balayage rapide, car il oblige les lecteurs à lire tout le texte autour du lien pour savoir quoi sélectionner.
N’oubliez pas que les interfaces utilisateur s’affichent différemment d’un appareil à l’autre. N’oubliez pas non plus que des utilisateurs peuvent consulter votre contenu à l’aide de technologies d’assistance.
Faites attention aux mots qui peuvent être employés à la fois comme verbes et comme noms ou adjectifs. Les formes verbales exigent généralement un espace entre les mots, tandis que les noms et les adjectifs peuvent être composés.
Mettez une majuscule uniquement au premier mot, ainsi qu’aux noms propres et aux noms de produits Auth0.
Évitez les tournures inutilement longues en employant des temps simples dans les titres.
Lorsque vous rédigez le texte d’introduction d’une série d’étapes, allez droit au but et soyez concis. N’oubliez pas que les utilisateurs savent déjà ce qu’ils ont à faire avec une liste d’étapes numérotées.
Indiquez aux utilisateurs quel sera le résultat de leur action avant de décrire l’action qu’ils doivent effectuer.
Dans chaque étape, indiquez à l’utilisateur ce qu’il doit faire dans l’ordre.
Les notes et les avertissements n’ont pas la même fonction. Les notes devraient fournir des renseignements généraux utiles à connaître, tandis que les avertissements contiennent des renseignements qui peuvent entraîner un échec si on n’en tient pas compte.
Si des renseignements doivent être présentés sous forme d’avertissement, placez l’avertissement exactement là où l’utilisateur doit effectuer l’action correspondante. Les utilisateurs ne devraient pas avoir à chercher les avertissements.