Fondamenti di scrittura di manuali in Word - Esempi sbagliati e come correggerli

Manuali operativi, istruzioni di lavoro, procedure di manutenzione, runbook interni. In documenti come questi ciò che ripaga in seguito non è la capacità di scrittura in sé, ma se si sta usando Word come “strumento per abbellire solo le apparenze”.

Approcci che sembrano veloci all’inizio —

• costruire i titoli solo con grassetto e dimensione carattere,
• riempire di spazi e Tab per allineare,
• premere Invio ripetutamente per raggiungere la pagina successiva,
• scrivere l’indice e i riferimenti di pagina a mano,
• inserire richieste di revisione nel corpo come testo rosso —

una volta che si insinuano, il documento si rompe a ogni revisione.

In questo articolo esponiamo le basi di Word che contano davvero per la scrittura di manuali, sotto forma di schemi sbagliati accoppiati a buone pratiche. Il setup presupposto è Word desktop come strumento principale, con .docx come formato primario.

Indice

1. Le conclusioni prima
2. Non trasformare Word in uno strumento di allineamento manuale
3. Schemi sbagliati e buone pratiche in una rapida panoramica
4. Punti che contano nella pratica
5. Il minimo indispensabile per un modello Word per manuali
6. Controlli pre-distribuzione
7. Riepilogo

1. Le conclusioni prima

Ecco le conclusioni anticipate. Ciò che ripaga nella scrittura di manuali sono questi quattro punti.

1. Lasciare che siano le funzionalità di Word a gestire la struttura Titoli, numerazione, indice, riferimenti e controllo delle pagine si gestiscono tramite stili, campi e interruzioni di Word, non a mano.

2. Non lasciare che siano gli spazi bianchi a gestire l’allineamento Spazi, Tab ripetuti e righe vuote multiple si rompono a ogni correzione. Usare impostazioni di paragrafo, rientri, tabelle e sezioni.

3. Non mischiare la revisione al corpo del testo Le istruzioni di revisione vanno nei commenti e nelle modifiche tracciate, non nel testo rosso del corpo. Così risulta chiaro cosa è stato finalizzato nella versione definitiva.

4. Aggiornare gli elementi automatici subito prima della distribuzione Aggiornare in un’unica passata l’indice, i numeri di pagina, i riferimenti incrociati e i numeri di figure/tabelle. Controllare l’accessibilità prima di produrre il PDF.

2. Non trasformare Word in uno strumento di allineamento manuale

La cosa più importante nello scrivere manuali è separare aspetto e struttura.

Per esempio, queste cose sono intrinsecamente “struttura”:

• Capitoli, sezioni, sottocapitoli
• Passo 1, Passo 2, Passo 3
• Figura 2-1, Tabella 3-2
• “Vedere Capitolo 4”
• Nessun numero di pagina sulla prima pagina solo
• Lo storico delle revisioni a ogni aggiornamento

Ma nei documenti fragili tutta questa struttura viene gestita come “modifiche di aspetto”:

• Ingrandire il testo per farlo sembrare un titolo
• Scrivere 1. a mano
• Allineare con spazi
• Andare alla pagina successiva con Invio
• Scrivere “vedi pagina 3” come testo letterale

Con questo approccio, correggere un punto ne rompe un altro da qualche parte.

Word dispone fin dall’inizio di funzionalità per gestire un documento come struttura: stili dei titoli, indici, impostazioni di paragrafo, elenchi multilivello, intestazioni/piedi pagina, interruzioni di sezione, didascalie, modifiche tracciate, Controllo accessibilità e altro. Per i manuali, usare solo queste basi elimina già molti incidenti.

3. Schemi sbagliati e buone pratiche in una rapida panoramica

4. Punti che contano nella pratica

4.1 Costruire i titoli solo con grassetto e dimensione carattere

Schema sbagliato Ingrandire il testo, renderlo grassetto e accontentarsi di qualcosa che “sembra un titolo”.

Perché fa male Word non considera quella riga un titolo vero. Lo spostamento tramite il riquadro di spostamento diventa più difficile e la riga non appare nell’indice automatico. Anche dal punto di vista dell’accessibilità, i titoli solo visivi sono uno svantaggio.

Buona pratica Assegnare Titolo 1 / Titolo 2 / Titolo 3 ai capitoli, alle sezioni e ai sottocapitoli. Quando si vuole cambiare l’aspetto, modificare lo stile — non il grassetto o la dimensione di ogni riga.

4.2 Allineare con spazi e Tab ripetuti

Schema sbagliato Riempire il vuoto tra il nome di un’operazione e la sua descrizione con spazi, spingere il numero di versione sul margine destro con Tab ripetuti, inserire pile di righe vuote al posto della spaziatura del paragrafo.

Perché fa male Un carattere in più e tutto si rompe. Cambiamenti di carattere, paragrafi aggiunti, conversione in PDF e co-authoring spostano tutto.

Buona pratica Lasciare che siano le impostazioni di paragrafo, non i caratteri, a gestire posizione e spaziatura. Usare rientri, tabulatori, spaziatura prima/dopo i paragrafi e tabelle dove necessario.

4.3 Interruzioni di pagina tramite ripetuti Invio

Schema sbagliato Volere che il capitolo successivo inizi in una nuova pagina, quindi premere Invio ripetutamente.

Perché fa male Non appena si aggiunge una riga in una pagina precedente, tutto si sposta. Comparono pagine bianche, un titolo rimane isolato nella pagina precedente e intestazioni o piedi pagina cambiano in punti non previsti.

Buona pratica Usare un’interruzione di pagina all’inizio di ogni capitolo e un’interruzione di sezione dove deve cambiare la gestione dei numeri di pagina o intestazioni/piedi. Quando qualcosa si rompe, attivare la visualizzazione ¶ e controllare le interruzioni di pagina e i simboli di paragrafo mentre sono visibili.

4.4 Non scrivere a mano indice, numerazione o riferimenti incrociati

Schema sbagliato Costruire la pagina dell’indice pezzo per pezzo e riscrivere nomi e numeri di capitolo a ogni revisione. Scrivere 1. 2. 3. o 1.1 1.2 direttamente nel corpo. Scrivere “vedi pagina 12” o “vedi Figura 3” come testo letterale.

Perché fa male Ogni revisione produce aggiornamenti mancati. Il classico incidente: il numero di pagina viene corretto ma il nome del titolo rimane vecchio.

Buona pratica Costruire un indice automatico dagli stili dei titoli. Tenere i passi come elenchi numerati e la gerarchia capitolo/sezione come elenco multilivello. Tenere i riferimenti ai numeri di figura, pagina e capitolo come riferimenti incrociati e campi, e aggiornarli tutti insieme alla fine.

4.5 Non scrivere intestazioni/piedi pagina e numeri di versione direttamente in ogni pagina

Schema sbagliato Inserire nome del documento, versione e numero di pagina direttamente su ogni pagina. Adattare manualmente il layout perché la prima pagina deve essere diversa.

Perché fa male Si dimentica di aggiornare la versione, i numeri di pagina si spostano e le cose si rompono nel momento in cui si vuole che solo l’appendice usi un formato diverso.

Buona pratica Spostare nome del documento, versione e numeri di pagina nell’intestazione / piè di pagina. Per una prima pagina distinta usare Prima pagina diversa; per cambiare per capitolo o appendice, usare interruzioni di sezione e scollegare Collega al precedente per intestazione/piè di pagina.

4.6 Separare modifiche tracciate, commenti e figure/tabelle

Schema sbagliato Lasciare note come “sistemare questo”, “da verificare”, “da discutere” in testo rosso e lasciarle finire nella versione finale. Incollare screenshot a tutto schermo senza numero di figura né spiegazione.

Perché fa male Diventa impossibile distinguere cosa è corpo del testo e cosa è nota di revisione. È anche il modo in cui le tracce di revisione finiscono nella versione finale.

Buona pratica Mettere le modifiche vere e proprie nelle modifiche tracciate e le discussioni o istruzioni nei commenti. Dare a figure e tabelle didascalie e impostare il testo alternativo dove necessario.

5. Il minimo indispensabile per un modello Word per manuali

Non serve subito un modello elaborato. All’inizio basta questo.

Inoltre, decidere regole operative a questo livello semplifica molto tutto ciò che segue.

• La copia master è .docx
• La distribuzione è in PDF
• Le revisioni usano le modifiche tracciate
• Aggiornare i campi prima della distribuzione
• Eseguire il Controllo accessibilità prima della distribuzione

6. Controlli pre-distribuzione

Prima di trasformare il manuale in PDF, è bene controllare almeno queste cose.

6.1 Aggiornare tutti i campi

Selezionare l’intero documento con Ctrl + A e aggiornare i campi. Questo riduce gli aggiornamenti mancati nell’indice, nei numeri di pagina, nei riferimenti incrociati e nei numeri di figure e tabelle.

6.2 Ripulire modifiche tracciate e commenti

Controllare che non rimangano modifiche in corso o commenti. Fare attenzione al caso in cui siano “solo nascosti” ma ancora presenti.

6.3 Controllare i livelli dei titoli

Confermare che la struttura dei capitoli usi coerentemente Titolo 1 / 2 / 3. Se questa gerarchia non è coerente, indice e spostamento vanno in pezzi.

6.4 Controllare immagini e tabelle

Confermare che figure e tabelle siano numerate, che le immagini non siano sovradimensionate e che il corpo spieghi cosa osservare.

6.5 Eseguire il Controllo accessibilità

Eseguire il Controllo accessibilità e confermare che non ci siano problemi con titoli, testo alternativo, contrasto, struttura delle tabelle e così via. Se si prevede la distribuzione in PDF, è più sicuro risolvere prima sul lato Word.

7. Riepilogo

La cosa che più si vuole evitare quando si costruiscono manuali in Word è gestire la struttura stessa a mano.

• Titoli tramite stili
• Passi tramite funzionalità di numerazione
• Indice automatico
• Controllo pagine tramite interruzioni di pagina e di sezione
• Figure e tabelle tramite didascalie
• Revisione tramite modifiche tracciate e commenti
• Riferimenti tramite riferimenti incrociati
• Aggiornamenti e controlli prima della distribuzione

In sintesi: non fermarsi a usare Word come “strumento per digitare caratteri” — usarlo come strumento per gestire la struttura del documento.

I manuali mostrano le loro differenze non nel momento in cui vengono scritti, ma in quello in cui vengono corretti. Un documento che si rompe a ogni revisione è di solito uno le cui basi di Word erano già crollate prima dei contenuti.

Viceversa, padroneggiare queste basi aumenta notevolmente la manutenibilità di un documento. Non c’è bisogno di puntare subito a un design elaborato. Il punto di partenza pratico è togliere queste cinque cose dal lavoro manuale: titoli, numerazione, indice, interruzioni di pagina e revisione.

Articoli correlati

Articoli recenti con gli stessi tag per approfondire argomenti vicini.

Argomenti correlati

Queste pagine collocano l’argomento in un contesto più ampio di servizi e decisioni.

Servizi collegati all’argomento

L’articolo è direttamente collegato ai servizi seguenti.

Domande frequenti

Domande che ricorrono nelle consulenze sull’argomento dell’articolo.

Perché non dovrei creare i titoli solo con testo in grassetto e dimensioni dei caratteri in Word?

Perché Word non considera una riga ingrandita e in grassetto un titolo vero. I titoli solo visivi non appaiono nel riquadro di spostamento né nell'indice automatico e sono uno svantaggio anche per l'accessibilità. Assegnare invece gli stili Titolo 1, Titolo 2 e Titolo 3 ai capitoli, alle sezioni e ai sottocapitoli; quando si vuole cambiare l'aspetto, modificare lo stile stesso anziché la formattazione di ogni riga.

Come faccio a impedire che un manuale Word si rompa a ogni revisione?

Lasciare che siano le funzionalità di Word a gestire la struttura invece di tenerla a mano. Usare interruzioni di pagina e di sezione anziché premere ripetutamente Invio, lasciare che impostazioni di paragrafo, rientri, tabulatori e tabelle gestiscano l'allineamento anziché spazi e tab ripetuti, e gestire i passi come elenchi numerati. I documenti che si rompono a ogni revisione sono di solito quelli in cui le basi di Word sono già crollate prima dei contenuti: correggere un punto rompe qualcos'altro perché le modifiche di aspetto sostituiscono la struttura.

Dovrei scrivere l'indice a mano in Word?

No. Un indice digitato a mano produce aggiornamenti mancati a ogni revisione: il classico incidente è un numero di pagina corretto ma un titolo di capitolo rimasto vecchio. Costruire un indice automatico dagli stili dei titoli, tenere i riferimenti ai numeri di figura, pagina e capitolo come riferimenti incrociati e campi, e aggiornarli tutti insieme subito prima della distribuzione.

Cosa controllo prima di distribuire un manuale Word come PDF?

Cinque cose: selezionare l'intero documento e aggiornare tutti i campi in modo che indice, numeri di pagina, riferimenti incrociati e numeri di figure e tabelle siano aggiornati; confermare che non rimangano revisioni o commenti, anche solo nascosti; verificare che la struttura dei capitoli usi Titolo 1, 2 e 3 in modo coerente; confermare che figure e tabelle siano numerate e spiegate nel corpo; eseguire il Controllo accessibilità per titoli, testo alternativo, contrasto e struttura delle tabelle. Farlo prima sul lato Word è più sicuro che correggere il PDF dopo.

Profilo dell’autore

Pagina di presentazione dell’autore dell’articolo.

Go Komura

Rappresentante di KomuraSoft LLC

Specializzato nello sviluppo di software Windows, nella consulenza tecnica e nell’analisi dei malfunzionamenti, soprattutto nei progetti con sistemi esistenti e guasti difficili da riprodurre.