brand-guidelines

Rédigez du contenu en suivant les directives de marque Sentry. À utiliser lors de la rédaction de texte d'interface utilisateur, de messages d'erreur, d'états vides, de flux d'intégration, de pages 404, de documentation, de contenu marketing ou de tout contenu visible par l'utilisateur. Couvre à la fois les 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 utilisateur du produit (boutons, étiquettes, formulaires) Pages 404
Documentation États vides
Messages d'erreur Flux d'onboarding
Pages de paramètres États de chargement
E-mails transactionnels Annonces « Quoi de neuf »
Texte d'aide Texte marketing

Par défaut, utiliser 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 d'interface.

Règles

  1. Être concis - Utiliser le moins de mots possible
  2. Être direct - Dire aux utilisateurs quoi faire, pas ce qu'ils peuvent faire
  3. Utiliser la voix active - « Enregistrer vos modifications » et non « Vos modifications seront enregistrées »
  4. Éviter le jargon - Utiliser des mots simples que les utilisateurs comprennent
  5. Être spécifique - « 3 erreurs trouvées » et non « Quelques erreurs trouvées »

Exemples

Au lieu de Écrire
« Cliquez ici pour enregistrer vos modifications » « Enregistrer »
« Vous pouvez filtrer les résultats par date » « Filtrer par date »
« Une erreur s'est produite » « Un problème s'est produit »
« Veuillez entrer une adresse e-mail valide » « Entrer une adresse e-mail valide »
« Êtes-vous sûr de vouloir supprimer ? » « Supprimer cet élément ? »

Sentry Voice

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

Principes

  1. Ironie empathique - Diriger la frustration vers la situation, jamais vers l'utilisateur
  2. Conscience de soi - Reconnaître l'absurdité du logiciel
  3. Amusant mais fonctionnel - La personnalité doit améliorer, non obscurcir le sens
  4. Moments mérités - Utiliser uniquement quand les utilisateurs ont le temps d'apprécier

Exemples

Pages 404 :

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

États vides :

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

Onboarding :

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

États de chargement :

« Calcul 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

  • Utiliser l'orthographe de l'anglais américain (color, pas colour)
  • Utiliser la Casse des titres pour les titres et les titres de page
  • Utiliser la Casse de phrase pour le corps du texte, les boutons et les étiquettes

Ponctuation

  • Pas de points d'exclamation dans le texte d'interface (exception : moments de célébration)
  • Pas de points dans les étiquettes ou le texte des boutons courts
  • Utiliser 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
S'il vous plaît (omis)
Désolé (être spécifique sur le problème)
Erreur survenue Un problème s'est produit
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 « real-time », « 1-10 »
Tiret en-dash (--) Plages, relations « 2023--2024 », « parent--child »
Tiret em-dash (---) Interruption, emphase « Errors---even small ones---matter »

Dans la plupart des contextes d'interface, utiliser des traits d'union. Réserver les tirets en-dash pour les plages de dates et les tirets em-dash pour la prose plus longue.

Directives des éléments d'interface

Boutons

  • Utiliser des verbes d'action : « Save », « Delete », « Create »
  • Être spécifique : « Create Project » et non simplement « Create »
  • Maximum 2-3 mots si possible
  • Pas de points ou de points d'exclamation

Messages d'erreur

  1. Dire ce qui s'est passé
  2. Dire pourquoi (si utile)
  3. Dire quoi faire ensuite

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

États vides

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

Bon : « Pas encore de projets. Créez votre premier projet pour commencer à suivre les erreurs. »

Dialogues de confirmation

  • Rendre l'action claire dans le titre
  • Expliquer les conséquences si destructif
  • Utiliser des étiquettes de bouton spécifiques (« Delete Project », pas « OK »)

Infobulles et texte d'aide

  • Garder moins de 2 phrases
  • Expliquer le « pourquoi », pas seulement le « quoi »
  • Faire un lien vers la documentation pour les sujets complexes

Anti-modèles

Éviter ces erreurs courantes :

  • Langage robotique : « Item has been successfully deleted » -> « Deleted »
  • Voix passive : « Changes were saved » -> « Changes saved »
  • Mots inutiles : « In order to » -> « To »
  • Hésitation : « This might cause... » -> « This will cause... »
  • Doubles négatifs : « Not unlike... » -> « Similar to... »
  • Langage marketing en interface : « Supercharge your workflow » -> « Speed up your workflow »

Références