Руководство по стилю шаблона

Это руководство по стилю было подготовлено, чтобы помочь вам принять решение о том, как подготовить шаблоны для Галереи шаблонов сообщества . Это руководство по стилю основано на принципах написания Google Material Design . Проще говоря, это:

• Будьте краткими
• Пишите просто и прямо
• Обращайтесь к пользователям четко
• Сообщите важные детали
• Пишите для всех уровней чтения
• Будьте людьми: пишите для людей, а не для роботов

Следуйте этим рекомендациям, чтобы обеспечить единообразный внешний вид всех шаблонов и помочь пользователям понять, как использовать ваш шаблон.

Информация

Эти рекомендации применимы к элементам, найденным на вкладке «Информация » редактора шаблонов.

Имя

Имя шаблона отображается пользователям Диспетчера тегов в пользовательском интерфейсе Диспетчера тегов и в галерее шаблонов сообщества. Он отображается в верхней части страницы сведений о шаблоне и появляется, когда шаблоны перечислены.

• Используйте название вашей компании/организации и функциональное имя шаблона: Название организации . Имя шаблона .
• Используйте регистр заголовков.
• Используйте термины, описывающие функциональность.
• Избегайте использования термина «Официальный» в названиях шаблонов, если вы не уполномочены на это соответствующей организацией.

Примеры: тег измерения конверсий MyCompany, переменная идентификатора кампании MyCompany.

Описание

Описание шаблона — это описание шаблона, которое отображается на страницах сведений в виде краткого описания функций шаблона.

• Используйте четкие и краткие предложения, чтобы описать, что делает шаблон.
• Четко укажите, какую пользу ваш шаблон принесет пользователю. Например: «Шаблон Audience Builder на example.com поможет вам создать новые списки аудитории на основе посетителей веб-сайта».
• Избегайте жаргона.
• Включите ссылки на дополнительную информацию, документацию и поддержку.

Икона

Значок вашего шаблона отображается в виде миниатюры в Диспетчере тегов и в галерее шаблонов сообщества.

• В качестве формата изображения используйте PNG, JPEG или GIF.
• Изображение должно быть квадратным, размером не менее 48 х 48 пикселей и не более 96 х 96 пикселей.
• Размер файла должен быть меньше 50 килобайт.
• Избегайте использования официальных логотипов компании, если вы не уполномочены на это соответствующей организацией.
• Поля
• Используйте вкладку «Поля» редактора шаблонов, чтобы добавлять элементы формы, такие как ввод текста, флажки и т. д.

Поля

Эти рекомендации по стилю применимы к вкладке «Поля » редактора шаблонов.

Имя параметра

Это имя поля, которое отображается в редакторе шаблонов, а не так, как оно отображается пользователю. Имена должны описывать тип используемых данных. Отформатируйте имена параметров как lowerCamelCase . Примеры: имя пользователя, идентификатор клиента, ShoppingCartValue .

Метки полей

Метки полей включают поля отображаемого имени, текст флажка и связанные элементы.

• Используйте регистр предложений.
• Короче лучше.
• Будьте описательными.
• Используйте общие слова.

Текст справки

Текст справки — это информационный контент, отображаемый в виде всплывающей подсказки, который помогает пользователю ввести допустимое значение в поле шаблона. Приведите пример входных данных, если это возможно, и опишите, как используется поле шаблона или эффект предоставления определенных значений.

• Используйте регистр предложений.
• Будьте кратки, но будьте человечны. Можно использовать сокращения и писать от 2-го лица (вы).
• Поддерживаемые типы полей
• Базовое форматирование HTML разрешено. Примеры: <strong> , <em> .

Поддерживаемые типы полей