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 d'écriture de Google Material Design. En termes simples, il s'agit des éléments suivants:
- Être concis
- Écrivez simplement et directement
- S'adresser clairement aux utilisateurs
- Communiquer les informations essentielles
- Écrire pour tous les niveaux de lecture
- Soyez humain: écrivez pour des humains, pas pour des robots
Suivez ces consignes pour vous assurer que tous les modèles ont un aspect cohérent et pour aider les utilisateurs à comprendre comment les utiliser.
Infos
Ces consignes s'appliquent aux éléments de l'onglet Info de l'éditeur de modèles.
Nom
Le nom du modèle est présenté aux utilisateurs de Tag Manager dans l'interface utilisateur de Tag Manager et dans la galerie de modèles de la communauté. Il s'affiche en haut de la page d'informations d'un modèle et 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 la casse de titre.
- Utilisez des termes descriptifs de la fonctionnalité.
- Évitez d'utiliser le terme "officiel" dans les noms de modèles, sauf si vous y êtes autorisé par l'organisation concernée.
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 apparaît sur les pages d'informations détaillées sous la forme d'un bref résumé de ses fonctionnalités.
- Utilisez des phrases claires et concises pour décrire ce que le modèle fait.
- Indiquez clairement en quoi votre modèle est bénéfique pour l'utilisateur. Par 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 de votre site Web."
- Évitez le jargon.
- Incluez des liens vers des informations, de la documentation et une assistance supplémentaires.
Icône
L'icône de votre modèle est représentée sous forme de vignette dans Tag Manager et dans la galerie de modèles de la communauté.
- Utilisez les formats d'image PNG, JPEG ou GIF.
- L'image doit être carrée, d'au moins 48 x 48 pixels et ne pas dépasser 96 x 96 pixels.
- La taille du fichier doit être inférieure à 50 ko.
- Évitez d'utiliser les logos officiels d'une entreprise, sauf si vous y êtes autorisé par l'organisation concernée.
- Champs
- Utilisez l'onglet "Champs" de l'éditeur de modèles pour ajouter des éléments de formulaire tels que des zones de texte, des cases à cocher, etc.
Champs
Ces consignes de style 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 tel qu'il apparaît pour l'utilisateur. Les noms doivent décrire le type de données utilisé. Formatez les noms de paramètres au format lowerCamelCase. Exemples:userName, customerID, shoppingCartValue.
Libellés des champs
Les libellés de champ incluent les champs de nom à afficher, le texte des cases à cocher et les éléments associés.
- Seule la première lettre du titre doit être en majuscule.
- Allez au plus court.
- Misez sur la description.
- 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 du modèle. Si possible, fournissez un exemple d'entrée et décrivez comment le champ du modèle est utilisé ou l'impact de la fourniture de certaines valeurs.
- Seule la première lettre du titre doit être en majuscule.
- Soyez concis, mais 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 pouvant faire référence à des variables. Le widget de saisie de texte affiché dans l'interface utilisateur de Tag Manager peut être un champ de texte à une ligne ou une saisie sur plusieurs lignes. |
| Menu déroulant | Menu déroulant dans lequel un seul élément peut être sélectionné comme valeur du paramètre de modèle. Listez les éléments par ordre alphabétique, sauf si vous avez une raison valable de ne pas le faire. |
| Case à cocher | Saisie de case à cocher. La valeur d'un paramètre de modèle de ce type est booléenne : "true" pour la case cochée, "false" pour la case non cochée. |
| 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 ne peut choisir qu'un seul choix comme valeur du paramètre de modèle. |
| Tableau simple | Entrée d'un tableau simple. Chaque cellule du tableau peut être modifiée sur place et ne peut être que de deux types: saisie de texte ou 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. |