Esta guía de estilo se creó para ayudarte a tomar decisiones sobre cómo preparar plantillas para la Galería de plantillas de la comunidad. Esta guía de estilo se basa en los principios de redacción de Material Design de Google. En pocas palabras, estos son los siguientes:
- Sé breve.
- Escribe de forma simple y directa
- Dirigirse a los usuarios de forma clara
- Comunica los detalles esenciales
- Escribe para todos los niveles de lectura
- Sé humano: escribe para personas, no para robots
Sigue estos lineamientos para asegurarte de que todas las plantillas tengan un aspecto coherente y ayudar a los usuarios a comprender cómo usarlas.
Información
Estos lineamientos se aplican a los elementos que se encuentran en la pestaña Info del editor de plantillas.
Nombre
El nombre de la plantilla se presenta a los usuarios de Tag Manager en la interfaz de usuario de Tag Manager y en la Galería de Plantillas de la Comunidad. Aparece en la parte superior de la página de detalles de una plantilla y cuando se muestran las plantillas.
- Usa el nombre de tu empresa o organización y el nombre funcional de la plantilla: Nombre de la organización Nombre de la plantilla.
- Usa mayúsculas de título.
- Usa términos que describan la funcionalidad.
- Evita usar el término "Oficial" en los nombres de las plantillas, a menos que la organización relevante te haya autorizado a hacerlo.
Ejemplos: Etiqueta de medición de conversiones de MyCompany, variable de ID de campaña de MyCompany
Descripción
La descripción de la plantilla es una descripción de la plantilla que aparece en las páginas de detalles como un breve resumen de su funcionalidad.
- Usa oraciones claras y concisas para describir lo que hace la plantilla.
- Indica claramente cómo beneficia tu plantilla al usuario. Por ejemplo: "La plantilla del Creador de públicos de Example.com puede ayudarte a crear nuevas listas de público a partir de los visitantes del sitio web".
- Evita la jerga.
- Incluye vínculos a información, documentación y asistencia adicionales.
Ícono
El ícono de tu plantilla se representa como una miniatura cuando aparece en Tag Manager y en la Galería de plantillas de la comunidad.
- Usa PNG, JPEG o GIF para el formato de imagen.
- La imagen debe ser cuadrada, de al menos 48 px por 48 px y no más de 96 px por 96 px.
- El tamaño del archivo debe ser inferior a 50 kilobytes.
- Evita usar logotipos oficiales de la empresa, a menos que la organización relevante te autorice a hacerlo.
- Campos
- Usa la pestaña Campos del editor de plantillas para agregar elementos de formulario, como entradas de texto, casillas de verificación, etcétera.
Campos
Estos lineamientos de estilo se aplican a la pestaña Campos del editor de plantillas.
Nombre del parámetro
Este es el nombre del campo tal como aparece en el editor de plantillas, pero no como aparece para el usuario. Los nombres deben describir el tipo de datos que se usan. Dales formato a los nombres de los parámetros como lowerCamelCase. Ejemplos: userName, customerID, shoppingCartValue.
Etiquetas de campo
Las etiquetas de campo incluyen campos de nombre visible, texto de casilla de verificación y elementos relacionados.
- Usa mayúscula inicial.
- Cuanto más breve, mejor.
- Sea descriptivo.
- Usa palabras comunes.
Texto de ayuda
El texto de ayuda es contenido informativo que se muestra como una información sobre la herramienta para ayudar al usuario a ingresar un valor válido en el campo de la plantilla. Si es posible, proporciona una entrada de ejemplo y describe cómo se usa el campo de plantilla o el efecto de proporcionar ciertos valores.
- Usa mayúscula inicial.
- Sé breve, pero muestra humanidad. Está bien usar contracciones y escribir en segunda persona (tú).
- Tipos de campos admitidos
- Se permite el formato HTML básico. Ejemplos:
<strong>,<em>.
Tipos de campos admitidos
Tipo |
Descripción |
|---|---|
| Entrada de texto | Entrada de texto. El valor de un parámetro de plantilla de este tipo será una cadena que puede hacer referencia a variables. El widget de entrada de texto que se renderiza en la interfaz de usuario de Tag Manager puede ser un campo de texto de una sola línea o una entrada de varias líneas. |
| Menú desplegable | Menú desplegable en el que solo se puede seleccionar un elemento como valor del parámetro de plantilla. Enlista los elementos en orden alfabético, a menos que haya un motivo válido para hacerlo de otro modo. |
| Checkbox | Entrada de casilla de verificación. El valor de un parámetro de plantilla de este tipo será booleano: verdadero para marcado y falso para no marcado. |
| Botón de selección | Entrada de radio. Un parámetro de plantilla de este tipo presenta una lista de opciones en la interfaz de usuario de Tag Manager, y el usuario solo puede elegir una de ellas como valor del parámetro de plantilla. |
| Tabla simple | Una entrada de tabla simple. Cada celda de la tabla se puede editar en su lugar y solo puede ser de dos tipos: una entrada de texto o un menú desplegable. El valor de un parámetro de plantilla de este tipo es un array de objetos: cada objeto codifica una fila, cada clave del objeto debe ser uno de los nombres de las columnas y cada valor del objeto es el valor de la celda correspondiente. |