Styleguide für Vorlagen

Dieser Styleguide soll Ihnen bei der Vorbereitung von Vorlagen für die Community-Galerie für Vorlagen helfen. Dieser Styleguide basiert auf den Schreibprinzipien von Google Material Design. Einfach ausgedrückt:

  • Präzise sein
  • Einfach und direkt schreiben
  • Nutzer klar ansprechen
  • Wichtige Details mitteilen
  • Für alle Lesestufen schreiben
  • Menschlich sein: für Menschen schreiben, nicht für Roboter

Mit diesen Richtlinien sorgen Sie dafür, dass alle Vorlagen einheitlich gestaltet sind und wie Nutzer Ihre Vorlage verwenden können.

Informationen

Diese Richtlinien gelten für Elemente auf dem Tab Info des Vorlageneditors.

Name

Der Vorlagenname wird Tag Manager-Nutzern auf der Benutzeroberfläche von Tag Manager und in der Community-Galerie für Vorlagen angezeigt. Es wird oben auf der Detailseite einer Vorlage angezeigt und erscheint, wenn Vorlagen aufgelistet werden.

  • Verwenden Sie den Namen Ihres Unternehmens oder Ihrer Organisation und den Funktionsnamen der Vorlage: Name der Organisation Vorlagenname.
  • Verwenden Sie Groß-/Kleinschreibung.
  • Verwenden Sie Begriffe, die die Funktion beschreiben.
  • Verwenden Sie den Begriff „offiziell“ nur dann in Vorlagennamen, wenn Sie von der entsprechenden Organisation dazu autorisiert wurden.

Beispiele: Conversion-Mess-Tag von MyCompany, Kampagnen-ID-Variable von MyCompany

Beschreibung

Die Vorlagenbeschreibung ist eine Beschreibung der Vorlage, die auf den Detailseiten als kurze Zusammenfassung der Vorlagenfunktionen angezeigt wird.

  • Verwenden Sie klare und prägnante Sätze, um die Funktion der Vorlage zu beschreiben.
  • Erläutern Sie klar, welche Vorteile Ihre Vorlage für den Nutzer hat. Beispiel: „Mit der Vorlage „Example.com Audience Builder“ können Sie neue Zielgruppenlisten von Websitebesuchern erstellen.“
  • Vermeiden Sie Fachjargon.
  • Geben Sie Links für weitere Informationen, Dokumentationen und Support an.

Icon

Das Vorlagensymbol wird als Miniaturansicht dargestellt, wenn es in Tag Manager und in der Community-Galerie für Vorlagen aufgeführt ist.

  • Verwenden Sie als Bildformat PNG, JPEG oder GIF.
  • Das Bild muss quadratisch, mindestens 48 x 48 Pixel und nicht größer als 96 x 96 Pixel sein.
  • Die Datei muss kleiner als 50 Kilobyte sein.
  • Verwenden Sie keine offiziellen Unternehmenslogos, es sei denn, Sie sind von der entsprechenden Organisation dazu autorisiert.
  • Felder
  • Verwenden Sie den Tab „Vorlagen“ im Vorlageneditor, um Formularelemente wie Texteingaben, Kästchen usw. hinzuzufügen.

Felder

Diese Stilrichtlinien gelten für den Tab Felder des Vorlageneditors.

Parametername

Das ist der Name des Feldes, wie er im Vorlageneditor angezeigt wird, aber nicht so, wie er für den Nutzer sichtbar ist. Namen sollten eine Beschreibung des verwendeten Datentyps sein. Formatieren Sie die Parameternamen als lowerCamelCase. Beispiele: userName, customerID, shoppingCartValue.

Feldlabels

Feldlabels umfassen Felder für Anzeigenamen, Kästchentext und zugehörige Elemente.

  • Verwenden Sie die korrekte Groß- und Kleinschreibung.
  • Eine kürzere Anzeige ist besser.
  • Verwenden Sie anschauliche Begriffe.
  • Verwenden Sie gängige Wörter.

Hilfetext

Der Hilfetext dient der Information und soll dem Nutzer helfen, einen gültigen Wert in das Vorlagenfeld einzugeben. Geben Sie nach Möglichkeit eine Beispieleingabe an und beschreiben Sie, wie das Vorlagenfeld verwendet wird oder welche Auswirkungen bestimmte Werte haben.

  • Verwenden Sie die korrekte Groß- und Kleinschreibung.
  • Präzise, aber natürlich. Es ist in Ordnung, Kontraktionen zu verwenden und in der zweiten Person zu schreiben.
  • Unterstützte Feldtypen
  • Grundlegende HTML-Formatierung ist zulässig. Beispiele: <strong>, <em>.

Unterstützte Feldtypen

Typ
 Beschreibung
Texteingabe Texteingabe. Der Wert eines Vorlagenparameters dieses Typs ist ein String, der auf Variablen verweisen kann. Das Texteingabe-Widget, das auf der Tag Manager-Benutzeroberfläche gerendert wird, kann entweder ein einzeiliges Textfeld oder eine mehrzeilige Eingabe sein.
Drop-down-Menü Drop-down-Menü, in dem nur ein einzelnes Element als Wert für den Vorlagenparameter ausgewählt werden kann. Listen Sie die Artikel in alphabetischer Reihenfolge auf, sofern es keinen guten Grund gibt.
Kästchen Kästcheneingabe. Der Wert eines Vorlagenparameters dieses Typs ist boolesch: „true“ für aktiviert, „false“ für deaktiviert.
Optionsfeld Funkeingabe Ein Vorlagenparameter dieses Typs enthält eine Liste mit Auswahlmöglichkeiten auf der Tag Manager-Benutzeroberfläche. Der Nutzer kann nur eine der Optionen als Wert für den Vorlagenparameter auswählen.
Einfache Tabelle Eine einfache Tabelleneingabe. Jede Zelle in der Tabelle kann direkt bearbeitet werden und jede Zelle kann nur zwei Typen haben: eine Texteingabe oder ein Drop-down-Menü. Der Wert eines Vorlagenparameters dieses Typs ist ein Array von Objekten: Jedes Objekt codiert eine Zeile, jeder Schlüssel im Objekt muss einer der Spaltennamen sein und jeder Wert im Objekt ist der Wert der entsprechenden Zelle.