Guide de style des modèles

Ce guide de style a été conçu pour vous aider à décider comment préparer des modèles pour la Galerie de modèles de la communauté. Ce guide de style est basé sur les principes de rédaction de Material Design de Google. Pour faire simple, voici quelques exemples:

  • Soyez concis
  • Écrivez facilement et directement
  • Adressez-vous clairement aux utilisateurs
  • Communiquez des informations essentielles
  • Écriture pour tous les niveaux de lecture
  • Soyez humain: écrivez pour l'être humain et non pour les robots

Suivez ces consignes pour vous assurer que l'apparence de tous les modèles est cohérente et pour aider les utilisateurs à comprendre comment les utiliser.

Infos

Ces consignes s'appliquent aux éléments disponibles dans l'onglet Infos de l'éditeur de modèles.

Nom

Le nom du modèle est visible par les utilisateurs de Tag Manager dans l'interface utilisateur de Tag Manager et dans la galerie de modèles de la communauté. Il apparaît en haut de la page d'informations d'un modèle et apparaît lorsque les modèles sont listés.

  • Utilisez le nom de votre entreprise/organisation et le nom fonctionnel du modèle : Nom de l'organisation Nom du modèle.
  • Utilisez une casse de titre.
  • Utilisez des termes décrivant la fonctionnalité.
  • Évitez d'utiliser le terme "officiel" dans les noms de modèles, sauf si l'organisation concernée vous y autorise.

Exemples:Balise de mesure des conversions MyCompany, variable d'ID de campagne MyCompany

Description

La description du modèle est une description du modèle qui s'affiche sur les pages d'informations et qui résume la fonctionnalité.

  • Utilisez des phrases claires et concises pour décrire la fonction du modèle.
  • Indiquez clairement en quoi votre modèle est bénéfique à l'utilisateur. Exemple : "Le modèle de l'outil de création d'audience Example.com peut vous aider à créer des listes d'audience à partir des visiteurs du site Web."
  • Évitez le jargon.
  • Inclure des liens pour obtenir des informations complémentaires, de la documentation et de l'aide.

Icône

L'icône de votre modèle est représentée par une vignette lorsqu'elle est répertoriée dans Tag Manager et dans la galerie de modèles de la communauté.

  • Utilisez le format d'image PNG, JPEG ou GIF.
  • L'image doit être carrée, mesurer au moins 48 x 48 pixels et ne pas dépasser 96 x 96 pixels.
  • La taille du fichier doit être inférieure à 50 kilo-octets.
  • Évitez d'utiliser les logos officiels de l'entreprise, sauf si l'organisation concernée vous y autorise.
  • Champs
  • Dans l'onglet "Champs" de l'éditeur de modèles, vous pouvez ajouter des éléments de formulaire tels que du texte, des cases à cocher, etc.

Champs

Ces consignes s'appliquent à l'onglet Champs de l'éditeur de modèles.

Nom du paramètre

Il s'agit du nom du champ tel qu'il apparaît dans l'éditeur de modèles, mais pas de l'utilisateur. Les noms doivent décrire le type de données utilisé. Utilisez le format lowerCamelCase pour les noms de paramètres. Exemples : userName, customerID, shoppingCartValue

Libellés de champ

Les libellés de champ incluent les champs de nom à afficher, le texte de la case à cocher et les éléments associés.

  • Seule la première lettre doit être en majuscule.
  • Allez au plus court.
  • Utilisez des mots clés descriptifs.
  • Utilisez des mots courants.

Texte d'aide

Le texte d'aide est un contenu informatif, affiché sous forme d'info-bulle, qui aide l'utilisateur à saisir une valeur valide dans le champ de modèle. Fournissez un exemple d'entrée, si possible, et décrivez comment le champ de modèle est utilisé ou l'effet de fournir certaines valeurs.

  • Seule la première lettre doit être en majuscule.
  • Soyez concis, mais soyez humain. Vous pouvez utiliser des contractions et écrire à la deuxième personne (vous).
  • Types de champs compatibles
  • La mise en forme HTML de base est autorisée. Exemples : <strong>, <em>.

Types de champs compatibles

Type
Description
Saisie de texte Saisie de texte. La valeur d'un paramètre de modèle de ce type est une chaîne qui peut faire référence à des variables. Le widget de saisie de texte affiché dans l'interface utilisateur de Tag Manager peut être une zone de texte sur une seule ligne ou une entrée multiligne.
Menu déroulant Menu déroulant dans lequel un seul élément peut être sélectionné comme valeur du paramètre de modèle. Lister les éléments par ordre alphabétique, sauf s'il existe une bonne raison de procéder.
Case à cocher Entrée de la case à cocher. La valeur d'un paramètre de modèle de ce type sera de type booléen: true pour coché, false pour décoché.
Case d'option Entrée radio. Un paramètre de modèle de ce type présente une liste de choix dans l'interface utilisateur de Tag Manager. L'utilisateur n'est autorisé à choisir qu'une seule des options comme valeur du paramètre de modèle.
Tableau simple Une entrée de table simple. Chaque cellule du tableau peut être modifiée et ne peuvent contenir que deux types: une entrée de texte ou un menu déroulant. La valeur d'un paramètre de modèle de ce type est un tableau d'objets: chaque objet encode une ligne, chaque clé de l'objet doit correspondre à l'un des noms de colonne et chaque valeur de l'objet est la valeur de la cellule correspondante.