¶ Scrittura e documenti

Scrittura chiara nei documenti tecnici: frasi, termini, struttura

Tecniche concrete per testi tecnici comprensibili: conclusione all'inizio, frasi brevi, forma attiva, termini coerenti, glossario e revisione.

Un documento tecnico può essere corretto in ogni dettaglio e restare inutile, se chi lo legge non riesce a capire che cosa deve sapere o fare. Relazioni di intervento, specifiche, rapporti di analisi, proposte: in tutti questi testi la chiarezza non è una questione di stile, ma di efficacia. Un'informazione che il lettore non trova o fraintende equivale a un'informazione mancante.

Scrivere in modo chiaro non significa semplificare i contenuti. Significa togliere gli ostacoli tra il lettore e le informazioni.

Prima la conclusione

Nei documenti di lavoro il lettore ha poco tempo e vuole sapere subito il punto. Mettete all'inizio ciò che conta di più, poi i dettagli a sostegno: è la struttura a piramide rovesciata.

Un esempio, in apertura di una relazione:

Da evitare: «In data 3 ottobre è pervenuta una segnalazione relativa a rallentamenti. A seguito di tale segnalazione sono state effettuate verifiche sui sistemi, che hanno evidenziato…»

Meglio: «I rallentamenti di ottobre erano causati dal disco del server di posta quasi pieno. Lo spazio è stato liberato e il servizio è tornato normale. Per evitare che si ripeta, proponiamo un avviso automatico all'80% di occupazione.»

Chi legge solo le prime tre righe ha già tutto: causa, stato attuale, proposta.

Frasi brevi, una cosa per frase

Una frase lunga con tre subordinate costringe il lettore a tenere a mente troppe informazioni insieme. Quando una frase supera le due righe, chiedetevi se contiene più di un'idea. Spesso si può dividere in due o tre frasi più brevi senza perdere nulla.

Non serve rendere tutto telegrafico: alternare frasi brevi e medie dà ritmo. Ma ogni frase dovrebbe portare un'informazione principale.

Forma attiva e soggetti chiari

La forma passiva nasconde chi fa che cosa. Nei documenti tecnici, dove le responsabilità contano, è un problema concreto.

Forma passiva o impersonale Forma attiva
Si è proceduto all'aggiornamento Il fornitore ha aggiornato il sistema
La verifica dovrà essere effettuata L'ufficio sistemi verificherà entro venerdì
È stato riscontrato un errore Il controllo notturno ha trovato un errore

La forma passiva resta utile quando chi agisce è irrilevante o sconosciuto, ma non dovrebbe essere la scelta automatica.

Verbi invece di nomi astratti

Il linguaggio burocratico trasforma i verbi in nomi: «effettuare la verifica» invece di «verificare», «procedere alla sostituzione» invece di «sostituire», «dare comunicazione» invece di «comunicare». Il testo si allunga e si appesantisce senza dire di più. Cercare queste costruzioni in revisione è uno dei modi più rapidi per alleggerire un testo.

Termini coerenti

Nella scrittura narrativa si cerca di non ripetere le parole. Nella scrittura tecnica è il contrario: una cosa, un nome. Se in un paragrafo si parla di «server», poi di «macchina», poi di «nodo», il lettore può legittimamente chiedersi se siano tre cose diverse.

  • Scegliete un termine per ogni concetto e usatelo sempre.
  • Definitelo la prima volta che compare, se non è ovvio per il pubblico.
  • Per documenti lunghi, preparate un glossario con i termini e le loro definizioni.
  • Sciogliete gli acronimi alla prima occorrenza: «rete privata virtuale (VPN)».

Numeri, unità e date

  • Scrivete numeri e unità in modo preciso: «12 GB», non «una dozzina di giga».
  • Usate un formato di data non ambiguo, specialmente con interlocutori di paesi diversi: «14 ottobre 2026» o «2026-10-14».
  • Indicate sempre il fuso orario per orari che riguardano persone in luoghi diversi.
  • Evitate gli aggettivi vaghi quando avete un dato: «molto più veloce» dice meno di «da 8 a 2 secondi».

Struttura visibile

Un lettore di documenti tecnici raramente legge dall'inizio alla fine: cerca. Aiutatelo con:

  • titoli informativi, che dicano che cosa contiene la sezione;
  • paragrafi brevi, ognuno con una frase iniziale che ne anticipa il contenuto;
  • elenchi per sequenze di passaggi o serie di elementi paralleli;
  • tabelle per confronti tra più opzioni su più criteri.

Usate gli elenchi con misura: un ragionamento con cause ed effetti si capisce meglio in un paragrafo che spezzato in punti.

Rivedere con metodo

La revisione è il momento in cui un testo diventa chiaro. Alcune tecniche efficaci:

  1. Lasciate passare del tempo, anche solo un'ora, prima di rileggere.
  2. Leggete ad alta voce: le frasi troppo lunghe si sentono.
  3. Cercate le parole vuote: «sostanzialmente», «di fatto», «al fine di», «in un'ottica di».
  4. Verificate un concetto, un termine con la funzione di ricerca.
  5. Fatelo leggere a una persona del pubblico previsto e chiedetele di riassumere il punto principale.

Nel mio lavoro l'ultimo passaggio è il più utile: se il riassunto del lettore non coincide con quello che intendevo dire, il problema è nel testo, non nel lettore.

In sintesi

  • Mettete conclusione e informazioni principali all'inizio, i dettagli dopo.
  • Frasi brevi, un'idea per frase, forma attiva con soggetti chiari.
  • Verbi al posto di nomi astratti; via le formule burocratiche.
  • Un concetto, un termine: definizioni, acronimi sciolti e glossario.
  • Struttura visibile e revisione con metodo, fino alla prova con un lettore reale.
MM
Marco Marzaduri

Marco Marzaduri si occupa di cybersecurity, informatica forense e sviluppo web. Laureato in informatica, unisce il rigore dell'analisi tecnica all'attenzione per le persone che usano la tecnologia.

Leggi anche