Guide de style

Ce guide de style contient des recommandations éditoriales pour les contributeurs de la documentation HubRise.

Introduction

Lorsque le guide de style HubRise ne donne pas de recommandation particulière sur un cas spécifique, le Guide de Style des Développeurs Google peut être utilisé comme référence.

Langue

Le lectorat francophone de la documentation vit majoritairement en France. La documentation doit donc être rédigée dans la langue usuelle de ce pays.

Si l'interface de la solution documentée n'est pas disponible en français, utilisez le terme non traduit provenant de l'interface, suivi de la traduction entre parenthèses.

Correct : Cliquez sur Connect (Connecter).

Vouvoiement

Utilisez le vouvoiement. Pour les instructions, privilégiez l'impératif.

Incorrect : Vous devez cliquer sur Se connecter.

Correct : Cliquez sur Se connecter.

Adressez-vous directement à votre interlocuteur sans vous inclure, donc sans utiliser la première personne du pluriel.

Neutralité de genre

Choisissez, dans la mesure du possible, des formulations qui ne marquent pas le genre.

Cette règle ne doit cependant pas nuire à la lisibilité. Les formes combinées, dites "écriture inclusive", doivent ainsi être évitées.

Majuscules

Pour un titre officiel, un nom, une marque déposée, un copyright, ou une chose unique dans l'univers, mettez une majuscule. En cas de doute, ne mettez pas de majuscule.

Pour une expression qui a un acronyme connu auprès de votre public cible, mettez une majuscule.

Ne pas mettre de majuscule aux titres. Accentuer les majuscules.

Incorrect : Eléments à fournir pour Lightspeed K Series.

Correct: Éléments à fournir pour Lightspeed K Series.

Listes

Écrivez une courte liste sous forme de phrase. Si la liste a plus de trois éléments ou qu'elle contient des instructions longues, écrivez-la sous forme de liste à puces.

Dans une liste à puces, chaque élément de la liste commence par une majuscule et se termine par un point, et non par un point-virgule. S'il s'agit d'un mot isolé, ne mettez aucune ponctuation à la fin de l'élément de la liste.

Par exemple, écrivez ainsi une courte liste : Une commande prend successivement les statuts Reçue, En attente et Validée.

Pour une liste plus longue, procédez comme suit :

Les statuts d'une commande sont les suivants :

• Reçue
• Acceptée
• En attente
• En préparation
• Livrée
• Rejetée

Ou :

Depuis votre tableau de bord, vous pouvez :

• Supprimer une commande.
• Accepter une commande.
• Accéder à la liste de vos clients.

Références

Liens

Utilisez des chemins relatifs pour les liens internes ou les renvois et des chemins absolus pour les liens externes. Les chemins relatifs ouvrent le lien dans le même onglet et les chemins absolus dans un nouvel onglet.

Lisibilité

La documentation doit être facile à "scanner". Assurez-vous que les lecteurs trouvent rapidement l'aide nécessaire. Adoptez un style concis, simple et objectif.

Pour rendre votre texte plus lisible, utilisez :

• Des phrases courtes.
• De petits paragraphes.
• Des listes à puces.
• Des tableaux.
• Des diagrammes.

Voix active

La voix active est une construction de phrase dans laquelle le sujet est la personne ou l'objet qui effectue l'action. La voix passive est une construction dans laquelle le sujet subit l'action.

Utilisez la voix active pour rendre votre message plus clair et éviter une écriture distante. Presque toutes les phrases passives ont un équivalent actif. N'utilisez la voix passive qu'en l'absence d'alternative en voix active.

Voici quelques exemples de phrases en voix active et passive :

Voix passive	Voix active
Le cheval est brossé par le cavalier.	Le cavalier brosse le cheval.
Le chien est promené par un vieil homme.	Un vieil homme promène le chien.
Le bébé est porté par une femme blonde.	Une femme blonde porte le bébé.

Politesse

Il est inutile d'être poli pour donner des instructions.

Incorrect : Veuillez cliquer sur Se connecter.

Correct : Cliquez sur Se connecter.

Conditions

Positionnez les conditions avant les instructions, afin de permettre au lecteur de sauter la phrase si la condition ne s'applique pas à son cas.

Incorrect : Cliquez sur Ok si un message d'erreur s'affiche.

Correct : Si un message d'erreur s'affiche, cliquez sur Ok.

Synonymes

Choisissez un terme unique pour chaque concept et utilisez toujours ce terme. Évitez d'employer des synonymes, qui pourraient perdre le lecteur. Votre texte n'a pas un objectif littéraire, mais explicatif.

Verbe "faire"

Evitez l'emploi du verbe "faire" et préférez-lui un verbe décrivant précisément l'action à réaliser.

Mise en forme

Gras

Utilisez l'écriture en gras pour les éléments d'interface, tels que les boutons et les menus. Par exemple : Depuis votre tableau de bord HubRise, dans le menu principal, cliquez sur CONNEXIONS.

Italique

Utilisez l'écriture italique pour définir les acronymes et pour les exemples.

Virgules

Pour les listes de trois éléments ou plus, n'ajoutez pas de virgule avant le dernier élément. Par exemple : Mon repas était composé d'une entrée, d'un plat principal, d'un dessert et d'un café.

Parenthèses

Limitez l'utilisation des parenthèses à la clarification d'acronymes, sinon écrivez une nouvelle phrase. Les lecteurs ont tendance à ignorer le contenu des parenthèses.

Guillemets

Réservez l'usage des guillemets aux citations. Incluez la ponctuation après les guillemets fermants.

Actions utilisateur

Description

Lorsque vous décrivez une action à réaliser, indiquez d'abord l'endroit où l'action doit être réalisée, puis décrivez l'action elle-même.

Incorrect : Cliquez sur Configuration dans le menu principal.

Correct : Dans le menu principal, cliquez sur Configuration.

Actions optionnelles

Si une action à réaliser est optionnelle, ajoutez Optionnel : avant la description de cette action.

Incorrect : (Optionnel) Cliquez sur Se connecter.

Correct : Optionnel : Cliquez sur Se connecter.

Référencement

Ajoutez un méta-titre et une méta-description à chaque page.

Méta-titre

Pour les pages de la documentation, le méta-titre est composé du titre de la page, suivi du nom de la section, suivi de "HubRise". Le séparateur est le caractère |.

Si le méta-titre ainsi obtenu comporte plus de 60 caractères, essayez d'en raccourcir la première partie, en résumant le titre de la page.

Les méta-titres suivent les même règles de capitalisation et de ponctuation que les autres titres.

Correct: Présentation générale | Lightspeed K Series | HubRise

Méta-description

Les méta-descriptions suivent les même règles de style, avec un point pour terminer la phrase.

La méta-description doit avoir 155 à 160 caractères. Google pourrait le tronquer si vous le rallongez. Le contenu doit être pertinent et unique par rapport aux autres pages. Il doit être facile à lire et offrir une description convaincante à l'aide de mots-clés importants.

Correct: structure de méta-description à utiliser pour chaque page de la documentation

• Présentation générale : Présentation générale de Lightspeed K Series, les raisons de connecter votre caisse à HubRise et liste des fonctionnalités de l'intégration avec HubRise.
• Connexion à HubRise : Étapes pour établir une connexion entre Lightspeed K Series et HubRise. Connectez votre caisse et synchronisez vos données avec d'autres applications.
• Associer les codes ref : Instructions pour associer les codes ref des produits Lightspeed K Series avec d'autres applications connectées à HubRise pour la synchronisation des données.
• Dépannage : Dépannage de la connexion entre Lightspeed K Series et HubRise. Connectez votre caisse et synchronisez les données entre vos applications avec facilité.
• Terminologie : Table de correspondance entre les termes utilisés par Lightspeed K Series et HubRise pour le même concept. Connectez vos apps et synchronisez vos données.
• FAQ : Questions fréquentes posées sur la connexion de Lightspeed K Series à HubRise. Connectez vos applications à HubRise avec facilité et synchronisez vos données.

Pour compléter une méta-description en maximisant le nombre de caractères, vous pouvez ajouter une courte phrase à la fin :

• Connectez vos apps et synchronisez vos données.
• Synchronisez vos données.
• Connectez vos apps.