brand-guidelines

Rédigez du contenu en suivant les directives de marque Sentry. À utiliser pour les textes d'interface, les messages d'erreur, les états vides, les flux d'onboarding, les pages 404, la documentation, les textes marketing ou tout contenu destiné aux utilisateurs. Couvre les deux tons : Plain Speech (par défaut) et Sentry Voice.

npx skills add https://github.com/getsentry/skills --skill brand-guidelines

Directives de marque

Rédigez le texte destiné aux utilisateurs en suivant les directives de marque de Sentry.

Sélection du ton

Choisissez le ton approprié en fonction du contexte :

Utiliser Plain Speech Utiliser Sentry Voice
Interface produit (boutons, libellés, formulaires) Pages 404
Documentation États vides
Messages d'erreur Flux d'intégration
Pages de paramètres États de chargement
E-mails transactionnels Annonces « Quoi de neuf »
Texte d'aide Texte marketing

Privilégiez Plain Speech sauf si le contexte demande explicitement de la personnalité.

Plain Speech (par défaut)

Plain Speech est clair, direct et fonctionnel. Utilisez-le pour la plupart des éléments UI.

Règles

  1. Soyez concis - Utilisez le moins de mots possible
  2. Soyez direct - Dites aux utilisateurs quoi faire, pas ce qu'ils peuvent faire
  3. Utilisez la voix active - « Enregistrez vos modifications » au lieu de « Vos modifications seront enregistrées »
  4. Évitez le jargon - Utilisez des mots simples que les utilisateurs comprennent
  5. Soyez spécifique - « 3 erreurs trouvées » au lieu de « Des erreurs ont été trouvées »

Exemples

À la place de Écrivez
« Cliquez ici pour enregistrer vos modifications » « Enregistrer »
« Vous pouvez filtrer les résultats par date » « Filtrer par date »
« Une erreur s'est produite » « Une erreur s'est produite »
« Veuillez entrer une adresse e-mail valide » « Entrez une adresse e-mail valide »
« Êtes-vous sûr de vouloir supprimer ? » « Supprimer cet élément ? »

Sentry Voice

Sentry Voice ajoute de la personnalité aux moments appropriés. Elle est empathique, consciente d'elle-même et occasionnellement ironique.

Principes

  1. Ironie empathique - Dirigez la frustration vers la situation, jamais vers l'utilisateur
  2. Conscient d'elle-même - Reconnaître l'absurdité du logiciel
  3. Amusant mais fonctionnel - La personnalité doit améliorer, non obscurcir la clarté
  4. Moments justifiés - À utiliser seulement quand les utilisateurs ont du temps pour l'apprécier

Exemples

Pages 404 :

« Cette page n'existe pas. Peut-être ne l'a-t-elle jamais existé. Peut-être que c'était un rêve. Quoi qu'il en soit, revenons sur la bonne voie. »

États vides :

« Pas d'erreurs pour le moment. Profitez de ce moment de paix tant qu'il dure. »

Intégration :

« Faisons apparaître votre première erreur. Ne vous inquiétez pas, ce n'est pas aussi effrayant que cela en a l'air. »

États de chargement :

« Crunch des chiffres... » « Récupération de vos données... »

Quand NE PAS utiliser Sentry Voice

  • Messages d'erreur (les utilisateurs sont frustrés)
  • Pages de paramètres (les utilisateurs sont concentrés)
  • Documentation (les utilisateurs ont besoin d'informations)
  • Flux de facturation/paiement (les utilisateurs ont besoin de confiance)

Règles générales

Orthographe et grammaire

  • Utilisez l'orthographe anglaise américaine (color, not colour)
  • Utilisez la casse titre pour les titres et les titres de page
  • Utilisez la casse de phrase pour le corps du texte, les boutons et les libellés

Ponctuation

  • Pas de points d'exclamation dans le texte UI (exception : moments de célébration)
  • Pas de points dans les libellés courts UI ou le texte des boutons
  • Utilisez des points dans les phrases complètes et le texte d'aide
  • Pas de MAJUSCULES sauf pour les acronymes (API, SDK, URL)

Choix de mots

Éviter Préférer
Veuillez (omettre)
Désolé (être spécifique sur le problème)
Une erreur s'est produite Une erreur s'est produite
Non valide (expliquer ce qui ne va pas)
Succès ! (décrire ce qui s'est passé)
Oups (être spécifique)

Utilisation des tirets

Type Utilisation Exemple
Trait d'union (-) Mots composés, plages « temps réel », « 1-10 »
Tiret demi-cadratin (--) Plages, relations « 2023--2024 », « parent--child »
Tiret cadratin (---) Interruption, emphasis « Les erreurs---même petites---comptent »

Dans la plupart des contextes UI, utilisez des tirets. Réservez les tirets demi-cadratins pour les plages de dates et les tirets cadratins pour le contenu plus long.

Directives pour les éléments UI

Boutons

  • Utilisez des verbes d'action : « Enregistrer », « Supprimer », « Créer »
  • Soyez spécifique : « Créer un projet » au lieu de simplement « Créer »
  • 2-3 mots maximum quand possible
  • Pas de points ou points d'exclamation

Messages d'erreur

  1. Dites ce qui s'est passé
  2. Dites pourquoi (si utile)
  3. Dites ce qu'il faut faire ensuite

Bon : « Impossible d'enregistrer les modifications. Vérifiez votre connexion et réessayez. » Mauvais : « Erreur : l'enregistrement a échoué. »

États vides

  1. Expliquez ce qui serait normalement ici
  2. Fournissez une action claire pour remplir l'état
  3. Sentry Voice est appropriée ici

Bon : « Aucun projet pour le moment. Créez votre premier projet pour commencer à suivre les erreurs. »

Dialogues de confirmation

  • Rendez l'action claire dans le titre
  • Expliquez les conséquences si destructrice
  • Utilisez des libellés de bouton spécifiques (« Supprimer le projet », pas « OK »)

Infobulles et texte d'aide

  • Gardez-les sous 2 phrases
  • Expliquez le « pourquoi », pas seulement le « quoi »
  • Lien vers la documentation pour les sujets complexes

Anti-modèles

Évitez ces erreurs courantes :

  • Parler robot : « L'élément a été supprimé avec succès » -> « Supprimé »
  • Voix passive : « Les modifications ont été enregistrées » -> « Modifications enregistrées »
  • Mots inutiles : « Afin de » -> « Pour »
  • Hésitation : « Cela pourrait causer... » -> « Cela causera... »
  • Double négation : « Pas contrairement à... » -> « Similaire à... »
  • Langage marketing dans l'UI : « Turbochargez votre workflow » -> « Accélérez votre workflow »

Références

Skills similaires