Conseils de rédaction pour les guides d’installation

Si vous n’avez pas accès à un guide de style complet, consultez ces conseils pour améliorer considérablement votre contenu.

Utilisez la voix active

Évitez la voix passive (to be + participe passé). Pour rendre votre texte plus dynamique, plus clair et (souvent) plus court, essayez d’utiliser un sujet agissant et la voix active chaque fois que possible.

À privilégier	À éviter
Une fois que vous avez ajouté la configuration requise, Auth0 traitera toutes les connexions de votre locataire à l’aide de cette Rule. Avant d’activer l’intégration en production, assurez-vous d’avoir configuré correctement tous les composants et d’avoir effectué une vérification sur un locataire de test.	Une fois la configuration requise ajoutée, toutes les connexions de votre locataire seront traitées par cette Rule. Assurez-vous que tous les composants ont été correctement configurés et vérifiés sur un locataire de test avant d’activer l’intégration en production.

Rendez les titres de liens faciles à parcourir

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 repérage rapide, car il oblige les lecteurs à lire tout le texte autour du lien pour savoir quoi sélectionner.

Préféré	Déconseillé
Vous pouvez utiliser Auth0 Dashboard ou la Management API pour personnaliser le texte de l’expérience Universal Login.	Cliquez ici.
Pour savoir comment attribuer des rôles aux membres d’organisations, consultez Ajouter des rôles aux membres de l’organisation.	Vous pouvez accéder à ce lien.

Rédigez des directives indépendantes de l’appareil

N’oubliez pas que les interfaces utilisateur s’affichent différemment d’un appareil à l’autre. N’oubliez pas non plus que certaines personnes peuvent utiliser des dispositifs adaptés pour consulter votre contenu.

À privilégier	À éviter
Sélectionnez Créer.	Cliquez sur Créer.
Passez à la vue Applications.	Passez à l’onglet Applications.
Repérez Secret client.	Faites défiler la page jusqu’à Secret client.

Utilisez correctement les verbes et les noms ou adjectifs

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 s’écrire en un seul mot.

À privilégier	À éviter
Log in to your account.	Login to your account.
Auth0 processes logins.	Auth0 processes log ins.
Set up your hardware.	Setup your hardware.
Describe your hardware setup.	Describe your hardware set up.

Utilisez la casse de phrase pour les titres

Mettez une majuscule seulement au premier mot ainsi qu’aux noms propres et aux noms de produits Auth0.

À privilégier	À éviter
Ajouter une dépendance	Ajouter une Dépendance
Valider la reprise de connexion	Valider la Reprise de Connexion
Créer une Action	Créer une action

Utilisez des temps simples dans les titres

Évitez les formulations inutilement longues en utilisant des temps simples dans les titres.

À privilégier	À éviter
Attribuer et modifier des utilisateurs	Attribution et modification des utilisateurs
Connecter une base de données personnalisée	Comment connecter une base de données personnalisée

Rédigez les étapes de façon concise

Lorsque vous rédigez un texte d’introduction à des étapes, soyez direct et concis. N’oubliez pas que les utilisateurs savent déjà quoi faire lorsqu’ils voient une liste d’étapes numérotées.

Préféré	Déconseillé
Pour installer le SDK :	Suivez les étapes ci-dessous :

Présentez les résultats attendus dans les étapes

Indiquez aux utilisateurs quel sera le résultat de leur action avant de décrire l’action qu’ils doivent effectuer.

Préféré	Déconseillé
Pour activer cette intégration, sélectionnez Enregistrer les modifications.	Sélectionnez Enregistrer les modifications pour activer cette intégration.

Énumérez les actions à l’intérieur des étapes, dans l’ordre

Dans chaque étape, indiquez à l’utilisateur ce qu’il doit faire dans l’ordre où il doit le faire.

Préféré	Déconseillé
Repérez la section Integrations, puis sélectionnez Add Integration.	Sélectionnez Add Integration dans la section Integrations.

Utilisez les notes et les avertissements de façon appropriée

Les notes et les avertissements n’ont pas la même fonction. Les notes doivent contenir des renseignements généraux utiles à connaître, tandis que les avertissements contiennent des renseignements dont le non-respect peut entraîner un échec. Si des renseignements doivent être présentés sous forme d’avertissement, vous devez placer l’avertissement exactement à l’endroit où l’utilisateur doit effectuer l’action correspondante. Les utilisateurs ne devraient pas avoir à chercher les avertissements.

​Utilisez la voix active

​Rendez les titres de liens faciles à parcourir

​Rédigez des directives indépendantes de l’appareil

​Utilisez correctement les verbes et les noms ou adjectifs

​Utilisez la casse de phrase pour les titres

​Utilisez des temps simples dans les titres

​Rédigez les étapes de façon concise

​Présentez les résultats attendus dans les étapes

​Énumérez les actions à l’intérieur des étapes, dans l’ordre

​Utilisez les notes et les avertissements de façon appropriée

​En savoir plus