Guida di stile per i modelli

Questa guida di stile è stata preparata per aiutarti a prendere decisioni su come preparare i modelli per la Galleria modelli della community. Questa guida di stile si basa sui principi di scrittura di Google Material Design. In parole povere, si tratta di:

  • Essere conciso
  • Scrivi in modo semplice e diretto
  • Rivolgiti agli utenti in modo chiaro
  • Comunica i dettagli essenziali
  • Scrivi per tutti i livelli di lettura
  • Scrivi per le persone, non per i robot

Segui queste linee guida per assicurarti che tutti i modelli abbiano un aspetto coerente e per aiutare gli utenti a capire come utilizzarli.

Informazioni

Queste linee guida si applicano agli elementi presenti nella scheda Informazioni di Editor di modelli.

Nome

Il nome del modello viene mostrato agli utenti di Tag Manager nell'interfaccia utente di Tag Manager e nella Galleria modelli della community. Viene visualizzato nella parte superiore della pagina dei dettagli di un modello e quando i modelli sono elencati.

  • Utilizza il nome della tua azienda/organizzazione e il nome funzionale del modello: Nome dell'organizzazione Nome del modello.
  • Usa la modalità Maiuscole/minuscole nel titolo.
  • Utilizza termini descrittivi della funzionalità.
  • Evita di utilizzare il termine "Ufficiale" nei nomi dei modelli, a meno che tu non disponga dell'autorizzazione dell'organizzazione pertinente.

Esempi: Tag di misurazione delle conversioni di MyCompany, variabile ID campagna di MyCompany

Descrizione

La descrizione del modello è una descrizione del modello che viene visualizzata nelle pagine dei dettagli come breve riepilogo della funzionalità del modello.

  • Utilizza frasi chiare e concise per descrivere la funzionalità del modello.
  • Indica chiaramente i vantaggi del tuo modello per l'utente. Ad esempio: "Il modello Generatore di segmenti di pubblico di Example.com può aiutarti a creare nuovi elenchi dei segmenti di pubblico dai visitatori del sito web".
  • Evita le espressioni gergali.
  • Includi link a informazioni, documentazione e assistenza aggiuntive.

Icona

L'icona del modello è rappresentata come miniatura quando è elencata in Tag Manager e nella Galleria modelli della community.

  • Utilizza PNG, JPEG o GIF per il formato dell'immagine.
  • L'immagine deve essere quadrata, di almeno 48 x 48 px e non superiore a 96 x 96 px.
  • Le dimensioni del file devono essere inferiori a 50 kilobyte.
  • Evita di utilizzare loghi aziendali ufficiali, a meno che tu non sia autorizzato a farlo dall'organizzazione pertinente.
  • Campi
  • Utilizza la scheda Campi dell'editor di modelli per aggiungere elementi del modulo come input di testo, caselle di controllo e così via.

Campi

Queste linee guida sullo stile si applicano alla scheda Campi dell'editor di modelli.

Nome del parametro

Si tratta del nome del campo visualizzato nell'editor di modelli, ma non come appare all'utente. I nomi devono descrivere il tipo di dati utilizzati. Formatta i nomi dei parametri come lowerCamelCase. Esempi:userName, customerID, shoppingCartValue.

Etichette dei campi

Le etichette dei campi includono i campi del nome visualizzato, il testo della casella di controllo e gli elementi correlati.

  • Usa la lettera maiuscola a inizio frase.
  • Breve è meglio.
  • Fornisci una descrizione dettagliata.
  • Utilizza parole comuni.

Testo della guida

Il testo di aiuto è un contenuto informativo, visualizzato come descrizione comando, che aiuta l'utente a inserire un valore valido nel campo del modello. Fornisci un esempio di input, se possibile, e descrivi come viene utilizzato il campo del modello o l'effetto della fornitura di determinati valori.

  • Usa la lettera maiuscola a inizio frase.
  • Sii conciso, ma umano. Puoi utilizzare le forme contratte e scrivere in seconda persona.
  • Tipi di campi supportati
  • È consentita la formattazione HTML di base. Esempi: <strong>, <em>.

Tipi di campi supportati

Tipo
 Descrizione
Inserimento di testo Immissione di testo. Il valore di un parametro del modello di questo tipo sarà una stringa che può fare riferimento a variabili. Il widget di immissione di testo visualizzato nell'interfaccia utente di Tag Manager può essere un campo di testo a una riga o un input multiriga.
Menu a discesa Menu a discesa in cui è possibile selezionare un solo elemento come valore del parametro del modello. Elenca gli elementi in ordine alfabetico, a meno che non ci sia un buon motivo per fare altrimenti.
Casella di controllo Input di caselle di controllo. Il valore di un parametro di modello di questo tipo sarà booleano: true per la selezione, false per la mancata selezione.
Pulsante di opzione Input radio. Un parametro modello di questo tipo presenta un elenco di opzioni nell'interfaccia utente di Tag Manager e l'utente può scegliere una sola opzione come valore del parametro modello.
Tabella semplice Un semplice input di tabella. Ogni cella della tabella può essere modificata in modo diretto e può essere di due tipi: inserimento di testo o menu a discesa. Il valore di un parametro del modello di questo tipo è un array di oggetti: ogni oggetto codifica una riga, ogni chiave nell'oggetto deve essere uno dei nomi di colonna e ogni valore nell'oggetto è il valore della cella corrispondente.