Questa guida di stile è stata realizzata 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 Material Design di Google. In breve, queste sono:
- Usa titoli concisi
- Scrivi in modo semplice e diretto
- Indirizza gli utenti in modo chiaro
- Comunica i dettagli essenziali
- Scrittura per tutti i livelli di lettura
- Sii umano: scrivi per gli esseri umani, non per i robot
Segui queste linee guida per fare in modo che tutti i modelli abbiano un aspetto e uno stile coerenti e per aiutare gli utenti a capire come utilizzare il modello.
Info
Queste linee guida si applicano agli elementi presenti nella scheda Informazioni dell'Editor 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. che viene visualizzato nella parte superiore della pagina dei dettagli del modello e quando sono elencati i modelli.
- Utilizza il nome dell'azienda o dell'organizzazione e il nome funzionale del modello: Nome organizzazione Nome modello.
- Caso d'uso del titolo.
- Utilizza termini che descrivano la funzionalità.
- Evita di utilizzare il termine "Ufficiale" nei nomi dei modelli, a meno che tu non abbia l'autorizzazione a farlo dall'organizzazione pertinente.
Esempi: tag di misurazione delle conversioni MyCompany, variabile ID campagna MyCompany
Descrizione
La descrizione del modello è una descrizione del modello che viene visualizzata nelle pagine dei dettagli come un breve riepilogo della funzionalità del modello.
- Utilizza frasi chiare e concise per descrivere lo scopo del modello.
- Indica in modo chiaro per l'utente i vantaggi del modello. Ad esempio: "Il modello del generatore di segmenti di pubblico Example.com può aiutarti a creare nuovi elenchi dei segmenti di pubblico dai visitatori del sito web".
- Evita di usare gergo tecnico.
- Includere link per ulteriori informazioni, documentazione e supporto.
Icona
L'icona del modello è rappresentata da una miniatura quando viene elencata in Tag Manager e nella Galleria modelli della community.
- Utilizza il formato PNG, JPEG o GIF per il formato dell'immagine.
- L'immagine deve essere quadrata, di almeno 48 x 48 px e di dimensioni non superiori a 96 x 96 px.
- Le dimensioni del file devono essere inferiori a 50 kilobyte.
- Evita di utilizzare i loghi ufficiali dell'azienda, a meno che tu non abbia l'autorizzazione a farlo dell'organizzazione pertinente.
- Campi
- Utilizza la scheda Campi dell'Editor modelli per aggiungere elementi del modulo come l'inserimento di testo, caselle di controllo e così via.
Campi
Queste linee guida relative allo stile si applicano alla scheda Campi dell'Editor modelli.
Nome del parametro
Si tratta del nome del campo come viene visualizzato nell'Editor modelli, ma non come viene visualizzato dall'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 campi per il nome visualizzato, testo della casella di controllo ed elementi correlati.
- Usa la lettera maiuscola a inizio frase.
- Breve è meglio.
- Fornisci una descrizione dettagliata.
- Utilizza parole comuni.
Testo della guida
Il testo della guida è del tipo informativo, mostrato come descrizione comando, per aiutare l'utente a inserire un valore valido nel campo del modello. Se possibile, fornisci un esempio di descrizione e descrivi come viene utilizzato il campo del modello o l'effetto di determinati valori.
- Usa la lettera maiuscola a inizio frase.
- Usa titoli concisi ma umani. È consentito utilizzare le contrazioni e scrivere in seconda persona (tu).
- Tipi di campi supportati
- È consentita la formattazione HTML di base. Esempi:
<strong>,<em>.
Tipi di campi supportati
Tipo |
Descrizione |
|---|---|
| Inserimento di testo | Inserimento di testo. Il valore di un parametro modello di questo tipo sarà una stringa che può fare riferimento a variabili. Il widget per l'inserimento di testo visualizzato nell'interfaccia utente di Tag Manager potrebbe essere un campo di testo su una sola riga o un input su più righe. |
| Menu a discesa | Menu a discesa in cui è possibile selezionare un solo elemento come valore del parametro modello. Elenca le voci in ordine alfabetico, a meno che non ci siano buone ragioni per fare altrimenti. |
| Casella di controllo | Input casella di controllo. Il valore di un parametro modello di questo tipo sarà booleano: vero per selezionato, falso per deselezionato. |
| Pulsante di opzione | Input della radio. Un parametro di questo tipo presenta un elenco di scelte nell'interfaccia utente di Tag Manager e l'utente può scegliere solo una delle scelte come valore del parametro modello. |
| Tabella semplice | Un semplice input da tabella. Ogni cella nella tabella può essere modificata in modo da contenere solo due tipi: un input di testo o un menu a discesa. Il valore di un parametro modello di questo tipo è un array di oggetti: ogni oggetto codifica una riga, ogni chiave nell'oggetto deve essere uno dei nomi delle colonne e ogni valore nell'oggetto corrisponde al valore della cella corrispondente. |