Guida di stile

Impostazioni locali: en-US

Caso d'uso: Prodotto SaaS B2B – Centro assistenza e UI

# Guida di stile: EN-US – Articoli del centro assistenza

## 1. Scopo e finalità

Questa guida di stile definisce gli standard di scrittura per tutta la **documentazione del Centro assistenza** in **inglese (Stati Uniti)**.

Si applica a:

- Articoli di istruzioni  
- Spiegazioni delle funzionalità  
- Guide alla risoluzione dei problemi  
- Voci delle FAQ  

**Pubblico:** utenti SaaS professionali in ruoli tecnici e aziendali  
**Obiettivo:** aiutare gli utenti a completare i compiti rapidamente, con fiducia e senza confusione.

---

## 2. Voce e tono

Il contenuto del Centro assistenza dovrebbe suonare:

- **Chiaro e professionale**
- **Sostenitivo e orientato alla soluzione**
- **Fiducioso, non promozionale**

Scriviamo come una guida che aiuta gli utenti a avere successo — non come un testo di marketing.

### Principi del tono

| Fai | Non fare |
|---|------|
| Sii calmo e diretto | Essere eccessivamente informale o chiacchierone |
| Concentrati sui prossimi passi | Concentrati solo su ciò che è andato storto |
| Usa un linguaggio neutro | Usa sarcasmo o umorismo |

**Esempi**

- ✅ "Se la connessione fallisce, controlla il tuo token API e riprova."  
- ❌ "Il tuo token è errato." Correggilo."

---

## 3. Grammatica e Stile di Scrittura

### 3.1 Rivolgersi direttamente al lettore

Usa **tu** per rendere chiare le istruzioni.

- ✅ "Puoi gestire gli utenti dalla pagina dell'amministratore."  
- ❌ "Gli utenti possono essere gestiti dalla pagina dell'amministratore."

---

### 3.2 Preferire la voce attiva

La voce attiva è più breve e più facile da seguire.

- ✅ "Seleziona **Salva modifiche**."  
- ❌ "Le modifiche devono essere salvate."

---

### 3.3 Mantenere le frasi concise

- Punta a **25 parole o meno**
- Un'idea principale per frase
- Suddividi spiegazioni lunghe in passaggi o punti

---

### 3.4 Usa un linguaggio semplice

Evita complessità inutili.

- ✅ "Inizia un nuovo progetto."  
- ❌ "Inizia la creazione di un nuovo progetto."

---

## 4. Terminologia e coerenza

### 4.1 Usa termini approvati

Usa i nomi dei prodotti e delle funzionalità esattamente come definiti.

- Mantieni la capitalizzazione coerente  
- Non inventare sinonimi per concetti chiave  

**Esempio**

- ✅ “workspace”  
- ❌ “spazio,” “area di progetto,” “ambiente”

---

### 4.2 Definisci acronimi poco comuni

I termini comuni (API, URL) non necessitano di definizione.  
Gli acronimi interni o poco comuni devono essere spiegati al primo utilizzo.

- ✅ “Single Sign-On (SSO)”  
- ❌ “SSO” senza contesto

---

### 4.3 Convenzioni dell'inglese americano

Usa sempre **l'ortografia en-US**.

- ✅ “customize,” “behavior”  
- ❌ “customise,” “behaviour”

---

## 5. Formattazione e standard Markdown

### 5.1 Intestazioni

Usa intestazioni chiare e basate su attività.

- ✅ "Reimposta la tua password"  
- ❌ "Panoramica del processo di reimpostazione della password"

Gerarchia dei titoli:

- `#` Titolo dell'articolo  
- `##` Sezioni principali  
- `###` Sottosezioni solo quando necessario  

---

### 5.2 Elenchi

Usa elenchi numerati per sequenze:

1. Apri **Impostazioni**  
2. Seleziona **Fatturazione**  
3. Scegli **Cambia piano**  

Usa punti per le opzioni:

- Gli amministratori possono gestire gli utenti  
- Gli editor possono aggiornare il contenuto  

---

### 5.3 Elementi UI

Formatta le etichette UI in modo coerente:

- Pulsanti: **grassetto**
- Percorsi di navigazione: usa frecce

Esempio:

Vai a **Impostazioni → Fatturazione → Cambia piano**.

---

### 5.4 Link

I link devono descrivere la destinazione.

- ✅ "Vedi la guida alla fatturazione"  
- ❌ "Clicca qui"

---

## 6. Struttura dell'articolo standard

Ogni articolo del Centro assistenza dovrebbe seguire questa struttura:

### 1. Riepilogo

Inizia con 1-2 frasi che spiegano il risultato.

> Questo articolo spiega come modificare il tuo piano di abbonamento.

---

### 2. Prerequisiti (opzionale)

Elenca i requisiti in anticipo.

- Permessi da amministratore  
- Abbonamento attivo  

---

### 3. Istruzioni passo-passo

I passaggi dovrebbero essere:

- Orientati all'azione  
- Un'azione per passaggio  
- Scritti come comandi  

Esempio:

1. Vai a **Impostazioni**.  
2. Seleziona **Fatturazione**.  
3. Scegli **Modifica piano**.  

---

### 4. Risultato atteso

Dì all'utente cosa dovrebbe succedere.

> Il tuo nuovo piano entra in vigore immediatamente dopo la conferma.

---

### 5. Passi successivi (opzionale)

Fornisci azioni o link correlati.

- Gestisci le fatture  
- Aggiorna il metodo di pagamento  

---

## 7. Risoluzione dei problemi e errori

### 7.1 Sii rassicurante

- ✅ “Non siamo riusciti a connetterci. Per favore riprova.”  
- ❌ “Connessione fallita. Errore critico.”

---

### 7.2 Concentrati sulle soluzioni

Includi sempre cosa dovrebbe fare l'utente dopo.

- Controlla le credenziali  
- Conferma i permessi  
- Contatta il supporto se necessario  

---

### 7.3 Non incolpare mai l'utente

Evita un linguaggio come:

- “Hai fatto qualcosa di sbagliato”  
- "Input non valido" (senza spiegazione)

Preferito:

> "Il token potrebbe essere scaduto." Genera uno nuovo e riprova."

---

## 8. Riepilogo Fai / Non Fai

### Do

- Scrivi contenuti focalizzati sui compiti e basati sui passaggi  
- Usa terminologia coerente  
- Mantieni le frasi brevi e dirette  
- Usa intestazioni e link descrittivi  
- Mantieni un tono calmo e di supporto  

### Non Fai

- Aggiungere linguaggio di marketing  
- Usa modi di dire o gergo  
- Mescola termini per lo stesso concetto  
- Dare la colpa all'utente nella risoluzione dei problemi  
- Scrivere lunghi paragrafi senza struttura  

---

## Esempio (Preferito)

Per modificare il tuo piano:

1. Vai a **Impostazioni → Fatturazione**  
2. Seleziona **Modifica piano**  
3. Scegli un'opzione e seleziona **Conferma**