Consigli pratici

In questo articolo

Se traduci dai anche una mano a controllare il testo originale. Se crei testi nuovi - tieni a mente cosa il testo deve dare agli utenti, come li può aiutare. Consulta anche la pagina Scrivere nuovi contenuti

Nome del prodotto e della ditta

Non chiamare mai il nostro prodotto solo Banana, ma sempre Banana Contabilità. Non chiamare mai la nostra ditta solo Banana, ma sempre Banana.ch SA

Usa la voce attiva

Usa la voce attiva invece di quella passiva. Nelle voci attive è il soggetto che compie l'azione invece che subirla. Nel limite del possibile scegli testi con voci attive.
Per esempio:
NO: Un nuovo file contabile è stato creato da Marco
SÌ: Marco ha creato un nuovo file contabile

Maiuscole/minuscole

  • Indirizzi email e web sono tutti minuscoli: info@banana.ch - www.banana.ch
  • Non mettere lettere maiuscole a caso in mezzo ad una frase. Alcune parole vanno sempre minuscole, altre sempre maiuscole. Vedi anche la Lista di parole
  • Solo i nomi propri delle parti del programma vanno in maiuscolo, NON i ruoli.
    Per esempio:
    NO: vai nella Tabella Registrazioni
    SÌ: vai nella tabella Registrazioni
    Nota anche come i nomi dei comandi sono in grassetto.

Titoli e sottotitoli

I titoli e i sottotitoli organizzano il contenuto per i lettori.
Usa sempre gli stili dei titoli Drupal e NON usare il grassetto.
I titoli 1 sono i titoli delle pagine e dei blog: danno un'idea di ciò che si sta per leggere. 
I titoli 2 sono i grandi titoli delle pagine Drupal, riportati poi anche in alto a destra con relativo link. Danno il filo logico della pagina. Questi titoli dovrebbero avere senso compiuto.
Importante: Non mettere mai un titolo 2 subito sotto il titolo 1 della pagina; non sta bene avere due titoli uno sotto l'altro - piuttosto metti un paio di righe di introduzione.
I sottotitoli (3, 4,5, ecc.) suddividono gli articoli in sezioni più piccole e specifiche.
I titoli e i sottotitoli devono essere organizzati in una gerarchia, con il titolo per primo, seguito dai sottotitoli in ordine.
Includi le parole chiave più importanti nelle tue intestazioni e sottotitoli e assicurati di trattare il punto principale del contenuto.

Stili titoli

Case Title - Stile a cammello - si mette la maiuscola alla prima lettera di ogni parola (tranne congiunzioni e articoli).
Esempio: Biancaneve e i Sette Nani
Questo stile è usato più che altro in inglese. In ITALIANO usiamo solo il Sentence case.

Sentence Case - Stile frase - si mette la maiuscola solo alla prima parola e ai nomi propri.
Esempio: Biancaneve e i sette nani.
Questo stile viene normalmente usato in tutta la nostra Documentazione online.

NON usare il grassetto nei titoli del sito - usa invece gli stili Drupal per Titolo 1, 2, 3, 4.
Se arrivi su pagine vecchie dove i titoli sono ancora in grassetto - toglilo.

Numeri

In generale, se i numeri sono all'inizio della frase scrivili in parola, altrimenti in numero.
Esempio: Dieci cani e 8 gatti.

Importi - Per gli importi, segna le migliaia con un apostrofo e i decimali con un punto.
Esempio: 10'980.50

Divise - Metti sempre la divise davanti all'importo usando il simbolo a 3 lettere. Esempio: EUR e non € - USD e non $

Percentuali - usa il simbolo % piuttosto che scrivere "per cento".

Liste

Le liste sono o di elenchi puntati o numerati. Utilizza gli elenchi per spiegare dei passi da seguire, gruppi o liste di informazioni. Fai una piccola introduzione della lista. Usa gli elenchi numerati solo quando l'ordine è importante, per esempio nelle fasi di un processo. Se l'ordine non è importante scegli i trattini o i punti.

  • Decidi se ci va o no il punto alla fine della frase e mettilo in tutti i punti.
  • Se si tratta di un elenco di testi brevi NON mettere il punto alla fine. Se sono testi brevi che non hanno senso compiuto (cioè se non c'è un verbo) NON mettere il punto alla fine. Se sono invece frasi lunghe o paragrafi interi, allora sì.
  • Metti sempre la lettera maiuscola all'inizio degli elenchi puntati.

Punti esclamativi (!)

Usali poco e solo uno alla volta. Troppi stonano.
Usali solo in un contesto positivo, mai in avvisi allerta o messaggi di errore.

Virgolette

I comandi di Banana Contabilità e i riferimenti ai nomi delle tabelle o viste del programma vanno evidenziate in grassetto e NON con le virgolette.

Punto e virgola

Usalo raramente. Se pensi di doverlo usare probabilmente hai una frase troppo lunga.

Percorsi

Quando devi indicare un percorso di comandi usa il segno >
Esempio: menu File > Proprietà file > Opzioni > File anno precedente
Ricordati che i comandi del programma vanno indicati in grassetto. Il segno > no.

Italico/corsivo

L'italico viene usato pochissimo, più che altro per indicare testi o titoli di riviste esterni a noi.
Esempio: La rivista Newsweek ha pubblicato un bell'articolo.

Immagini

Le immagini dovrebbero essere sempre fatte con lo stile Paragrafo. Questo per evitare che risultino appiccicate al testo che le segue o che le precede. Per essere sicuri si può andare anche nella sorgente. Un'immagine deve sempre risultare così:

<p>
   <img src="https://raw.githubusercontent.com/BananaAccounting/doc10/master/en/doss…" alt="manage dossiers and files " width="1283" height="488">
</p>

Il testo alt= è il testo alternativo che appare a chi non vede le immagini nel browser. Meglio metterlo. Attenzione che anche se le immaini sono tutte in inglese il testo alternativo dovrebbe essere tradotto nelle varie lingue.

Bottoni

I bottoni dovrebbero sempre contenere azioni.
Il linguaggio deve essere chiaro e conciso. Metti la maiuscola ad ogni parola, compresi gli articoli.

I bottoni standard del sito web:

  • Prova gratis
  • Acquista ora
  • Iscriviti
  • Mandaci un email

Caselle

Usa il Sentence case - stile frase per le caselle.

Formulari

I titoli dei formulari devono spiegarne chiaramente e rapidamente lo scopo.
Mantieni il formulario il più corto possibile. Richiedi solo le informazioni di cui abbiamo bisogno e che intendiamo utilizzare.

Link

Fornisci un link ogni volta che ti riferisci a qualcosa su un sito web esterno. Utilizza i link per indirizzare gli utenti a contenuti rilevanti e risorse esterne di fiducia.
Non includere gli articoli alla parola del link.
Esempio:
NO: Leggi la guida all'automazione per i dettagli.
SÌ: Leggi la guida all'automazione per i dettagli.

Se il link è alla fine di una frase o prima di una virgola, non mettere il link alla punteggiatura.

Il link è come un cartello stradale - scrivi sempre la destinazione!

Non scrivere: "Clicca qui" o "Clicca per maggiori informazioni" o "Leggi questo".
Scrivi la frase come faresti normalmente e metti il link alle parole chiave rilevanti.
Esempio:
NO: Maggiori informazioni
SÌ: Come iniziare subito con il libro cassa

Link dentro le pagine

Drupal mette sempre a dx di ogni pagina i link ai testi Titoli 2 della pagina stessa.
Non usiamo questi link! Se infatti cambia anche un solo carattere del titolo in questione, il link non funziona più.
Creiamo piuttosto delle ancore nei punti cruciali della pagina.

Ancore

Per creare un'ancora usiamo il GPT Drupal aggiungi ANCORA che ha fatto Ivan.
Le ancore più efficaci sono create con parole corte, sempre in inglese. Se l'ancora è composta da 2 parole usiamo  il segno _ per unirle al posto dello spazio.
Per esempio #file_new invece di #file new

Articoli correlati

A volte un testo si presta ad una lista di link correlati alla fine. Non esagerare; max 3-4 di solito sono sufficienti.
Gli articoli correlati dovrebbero apparire in un ordine logico. Evita di ripetere collegamenti già inseriti nel corpo del testo.

SEO (= Search Engine Optimization)

  • Focalizza la tua pagina su un argomento. Usa termini chiari e descrittivi nei titoli e intestazioni che si riferiscono all'argomento in questione.
  • Usa titoli descrittivi per strutturare la tua pagina ed evidenziare informazioni importanti.
  • Dai ad ogni immagine un testo alternativo.

AI Optimization

Le pagine devono essere accattivanti e sintetiche per il pubblico umano, ma, anche in fondo, possono contenere informazioni più corpose e dettagliate per l'Intelligenza Artificiale. Importante definire oltre che i contenuti della pagina, a che pubblico è rivolto, il contesto in cui viene scritta (es. parte della documentazione Banana, software contabile), e altre info utili.