Esta guía de estilo ha sido preparada para ayudarlo 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 escritura de Google Material Design . En pocas palabras, estos son:
- Sé conciso
- Escribe simple y directamente
- Dirigirse claramente a los usuarios
- Comunicar detalles esenciales
- Escribe para todos los niveles de lectura.
- Sea humano: escriba para humanos, no para robots
Siga estas pautas para ayudar a garantizar que todas las plantillas tengan una apariencia uniforme y para ayudar a los usuarios a entender cómo usar su plantilla.
Información
Estas pautas se aplican a los elementos que se encuentran en la pestaña Información 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 aparece cuando se enumeran las plantillas.
- Utilice el nombre de su empresa/organización y el nombre funcional de la plantilla: Nombre de la organización Nombre de la plantilla.
- Usar mayúsculas y minúsculas.
- Utilice términos que sean descriptivos de la funcionalidad.
- Evite el uso del término "Oficial" en los nombres de las plantillas, a menos que esté autorizado por la organización correspondiente.
Ejemplos: etiqueta de medición de conversión 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 la funcionalidad de la plantilla.
- Use oraciones claras y concisas para describir lo que hace la plantilla.
- Indique claramente cómo su plantilla beneficia al usuario. Por ejemplo: "La plantilla Audience Builder de Example.com puede ayudarlo a crear nuevas listas de audiencia a partir de los visitantes del sitio web".
- Evite la jerga.
- Incluya enlaces para obtener información adicional, documentación y soporte.
Icono
El icono de su plantilla se representa como una miniatura cuando aparece en Tag Manager y en la Galería de plantillas de la comunidad.
- Utilice 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.
- Evite el uso de logotipos oficiales de la empresa, a menos que esté autorizado para hacerlo por la organización pertinente.
- Campos
- Use la pestaña Campos del Editor de plantillas para agregar elementos de formulario como entrada de texto, casillas de verificación, etc.
Campos
Estas pautas 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 ser descriptivos del tipo de datos utilizados. Formatee los nombres de los parámetros como lowerCamelCase . Ejemplos: nombre de usuario, ID de cliente, valor del carrito de compras .
Etiquetas de campo
Las etiquetas de campo incluyen campos de nombre para mostrar, texto de casilla de verificación y elementos relacionados.
- Usar mayúsculas y minúsculas.
- Más corto es mejor.
- Sea descriptivo.
- Usa palabras comunes.
Texto de ayuda
El texto de ayuda es contenido informativo, que se muestra como información sobre herramientas, para ayudar al usuario a ingresar un valor válido en el campo de la plantilla. Proporcione una entrada de ejemplo, si es posible, y describa cómo se usa el campo de plantilla o el efecto de proporcionar ciertos valores.
- Usar mayúsculas y minúsculas.
- Sé conciso, pero sé humano. Está bien usar contracciones y escribir en segunda persona (tú).
- Tipos de campo admitidos
- Se permite el formato HTML básico. Ejemplos:
<strong>,<em>.
Tipos de campo 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 representado 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 único elemento como valor del parámetro de plantilla. Enumere los elementos en orden alfabético a menos que haya una buena razón para hacerlo de otra manera. |
| Caja | Entrada de casilla de verificación. El valor de un parámetro de plantilla de este tipo será booleano: verdadero para marcado, falso para no marcado. |
| Boton de radio | 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 las opciones como el valor del parámetro de plantilla. |
| mesa sencilla | Una entrada de tabla simple. Cada celda de la tabla se puede editar en su lugar, y cada celda 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 una matriz de objetos: cada objeto codifica una fila, cada clave del objeto debe ser uno de los nombres de columna y cada valor del objeto es el valor de la celda correspondiente. |