Style guide

​

Ton et voix

• Utilisez la voix active et la deuxième personne (« vous »)
• Gardez les phrases courtes – une idée par phrase
• Mener avec l’objectif, puis donner des instructions
• Évitez les mots de remplissage inutiles
• Pas de couverture – soyez confiant et direct
• Pas de langage marketing : les documents informent, ils ne vendent pas

​

Attributs vocaux

​

Paramètres de tonalité

​

Conventions linguistiques

​

Terminologie

​

Références produits

• Distinguer Primo d’un autre système
• Première mention dans un document
• Le contexte ne serait pas clair sans cela

​

Acronymes

​

Conventions de style

​

Rubriques

• Utilisez la casse de la phrase : « Configurez votre compte » et non « Configurez votre compte »
• Utilisez des verbes impératifs : « Configurer SSO » et non « Configuration de SSO »
• Gardez les titres concis et orientés vers l’action

​

Formatage

• Gras pour les éléments de l’interface utilisateur : cliquez sur Paramètres > Intégrations.
• Surveillez les ** parasites : des marqueurs gras qui n’étaient pas correctement fermés ou qui ont fui d’une travée précédente. Une ligne doit toujours avoir un nombre pair de marqueurs **. Modèles courants à attraper :
  • ***word** (* supplémentaire) → **word**
  • **word **other** (marqueur ouvert imbriqué) → **word other**
• Code formatting pour :
  • Noms de fichiers : config.json
  • Commandes : mint dev
  • Chemins : /api/employees
  • Références du code : deviceId
• Utilisez <Steps> pour les étapes séquentielles — préférez-le aux listes numérotées chaque fois que les étapes suivent un ordre défini
• Dans les attributs <Step title="...">, n’utilisez pas de formatage markdown : le gras (**) et les liens ([text](url)) s’affichent sous forme de caractères littéraux dans les attributs JSX. Texte brut uniquement dans les titres ; utilisez le corps de l’étape pour un contenu riche si nécessaire
• Utilisez des puces pour les éléments non séquentiels

<Steps>
  <Step title="Navigate to Settings > Team">
  </Step>
  <Step title="Click 'Add member'">
  </Step>
  <Step title="Enter one or multiple email address(es) and choose a role">
    To invite multiple members at the same time, you can specify multiple
    emails separated with commas in the 'Email' field.
  </Step>
</Steps>

​

Structure des articles

1. Titre — Verbe impératif + objet (par exemple, « Connectez votre système RH »)
2. Description — Résumé en une phrase de ce que le lecteur accomplira
3. Prérequis – Énumérer les exigences avant de commencer (le cas échéant)
4. Étapes – Instructions numérotées avec des actions claires
5. Prochaines étapes — Lien vers le contenu connexe (le cas échéant)

​

Groupes de cartes

• Maximum 3 cards per row — Use cols={3} or fewer for readability
• Gardez la copie de la carte synchronisée — Les titres et les descriptions des cartes doivent correspondre à la couverture de l’article référencé.
• Utiliser des cartes pour les collections – Idéal pour les pages de présentation renvoyant vers du contenu connexe

<CardGroup cols={3}>
  <Card title="Connect your HR system" icon="users" href="/fr/employees/connect-hris">
    Sync employee data automatically from your HR system.
  </Card>
  <Card title="Import via CSV" icon="file-csv" href="/fr/employees/import-via-csv">
    Bulk import employees using a spreadsheet.
  </Card>
  <Card title="Automate onboardings" icon="wand-magic-sparkles" href="/fr/employees/automate-onboardings">
    Set up automatic device provisioning for new hires.
  </Card>
</CardGroup>

​

Référence rapide