Come scrivere un manuale

Finora ho scritto tre manuali, il primo con due edizioni. Si trattava della guida a WordPress per principianti, che a breve vorrei riscrivere. Ho scritto poi un manuale sul fumetto umoristico, che andrebbe revisionato, e uno sul blogging, che non vale più la pena revisionare (leggi: ne farò una versione diversa).

Questo post nasce in risposta alla richiesta di un’amica a cui è stato commissionato un manuale e vorrebbe sapere da che parte cominciare.

Un manuale è un libro

Quando ho avuto la prima idea di scrivere un manuale, ho pensato subito che un manuale – o guida, poco cambia – è pur sempre un libro, quindi non va affrontato come un semplice articolo, ma va progettato in ogni dettaglio.

Non si può scrivere di getto un manuale, secondo me, perché è un lavoro che richiede una buona e funzionale organizzazione dei contenuti. Per quanto mi riguarda, neanche un romanzo si dovrebbe scrivere di getto, ma nella narrativa esistono opinioni differenti.

Un manuale, però, deve guidare il lettore lungo un percorso, quindi dobbiamo capire cosa inserire prima e cosa è meglio far leggere dopo.

Definire il lettore

Quando ho scritto la mia guida a WordPress, ho avuto in mente subito i miei lettori e nel titolo del mio manuale era chiaro chi fossero: Guida a WordPress per principianti. Il mio lettore era il principiante, chi per la prima volta si avvicinava a WordPress.

Perché è così importante capire i lettori del nostro manuale? Perché influenzano l’intera comunicazione del nostro testo. Una Guida avanzata a WordPress, per esempio, non potrebbe essere letta da principianti, perché non capirebbero quasi nulla.

Dalla mia guida, infatti, ho dovuto escludere alcuni argomenti, come le personalizzazioni avanzate della sidebar o i modelli di pagine o perfino come creare un template per WordPress da zero, concetti che soltanto per un utente esperto risulterebbero chiari.

Definire lo scopo del manuale

L’obiettivo del manuale è legato al lettore. Se la mia guida a WordPress è per i principianti, allora quale sarà lo scopo di quel manuale? Far conoscere e apprezzare WordPress a quegli utenti base.

Ecco che 2 parole, 2 concetti riescono a definire gli obiettivi del mio manuale:

1. conoscenza: il testo deve fornire tutte le informazioni necessarie per permettere al lettore di usufruire di quelle conoscenze. Dopo la lettura della mia guida a WordPress, il lettore doveva essere in grado di usare WordPress.
2. apprezzamento: questo è forse ancora più importante, perché chi scrive un manuale deve riuscire a far amare quell’argomento al lettore. Il motivo è semplice: il lettore imparerà prima e meglio.

Delimitare i confini della materia

Ecco perché parlo di progettazione. Ho studiato la mia guida a WordPress e quella al blogging su carta. Quest’ultima, poi, ha subito diverse modifiche e la sua stesura ha richiesto qualche anno, anche se a tempo perso.

Però dobbiamo sapere con certezza cosa inserire nel nostro manuale e cosa è meglio tralasciare e non solo per una questione di lettori. Dobbiamo anche sapere cosa possiamo dare per scontato ai lettori e quanto invece dobbiamo suggerire loro.

Ma ogni manuale deve avere i suoi confini. Racchiudere un certo numero di argomenti che, insieme, definiscono obiettivi e pubblico cui è rivolto.

Creare una scaletta di argomenti

Prima ho parlato di un percorso da seguire per il lettore. Questo percorso è ben rappresentato da una scaletta che facciamo quando studiamo il nostro progetto letterario.

Questo è il motivo principale per cui io progetto sempre su carta un manuale o un romanzo che devo scrivere: ho così una visione d’insieme dell’opera e posso capire immediatamente se un argomento è bene inserirlo prima o dopo.

Impostare parti, capitoli, appendici

Premesso che ognuno è libero di suddividere la materia come vuole, io sono solito creare prima delle macrosezioni del mio manuale. Per fare un esempio, nella mia guida a WordPress avevo soltanto dei capitoli e dei paragrafi, mentre la guida al blogging era divisa in 3 parti, ognuna con un certo numero di capitoli.

In entrambi le guide ho creato anche delle appendici, in cui spiegavo argomenti che non trovavano posto nei capitoli ma che ritenevo utili e in cui suggerivo delle risorse online per approfondire.

Sono state necessarie anche delle note esplicative, che ho preferito inserire a fine pagine e non a fine capitolo o, peggio, a fine libro, come usano molte case editrici, obbligandomi a perdere tempo per andarle a cercare.

Linguaggio e stile di scrittura

Come si scrive un manuale? Il linguaggio dipende principalmente dai lettori cui è destinato e credo anche che vari da manuale a manuale. Certo, se parliamo di un manuale che spiega come costruire un missile atomico, non possiamo aspettarci un linguaggio comprensibile.

Ma Paul Davis è riuscito a scrivere una sorta di guida su come costruire una macchina del tempo con un linguaggio adatto a tutti, quindi niente è impossibile.

Si parla sempre di usare parole semplici, ma stiamo parlando di scrivere una guida, magari su un argomento tecnico, e in quel caso alcuni termini sono obbligatori. Quando scrivo un manuale, io considero:

• il lettore tipo di riferimento
• la natura del manuale
• gli obiettivi del manuale
• la persona da usare (il tu, il voi o perfino il noi)
• lo stile, se accademico, formale o colloquiale

Ricercare le fonti

Anche se stiamo scrivendo un manuale su un argomento che ci compete, abbiamo comunque bisogno di documentarci su qualche tema. Anzi, quelle fonti ci tornano utili se vogliamo offrire ai lettori spunti di approfondimento.

A me piace sempre scrivere un’introduzione al manuale e in quello sul blogging mi sono anche documentato sulla storia dei blog e su altri concetti che avevo introdotto.

Preparare le immagini

Non so se esistano manuali senza figure, in quelli che ho scritto – e in altri che ho iniziato a progettare – le immagini ci sono. Nella guida a WordPress avevo creato immagini per ogni funzione del pannello di controllo. È stato un lavoraccio lungo di schermate e ritagli con Photoshop, ma quelle immagini servivano.

Considerate quindi che il vostro manuale potrebbe essere illustrato. In quel caso, se non siete in grado di creare da voi le immagini, dovete chiedere a fotografi, grafici e disegnatori.

Bibliografia e sitografia

Forse non sono sempre necessarie, ma tenete sempre un elenco delle fonti che avete usato e che sarebbe bene inserire a fine manuale. Daranno un aspetto più professionale alla vostra opera, i dovuti crediti agli autori che avete letto e materiale per ampliare la conoscenza ai vostri lettori.

Questo è il metodo che ho usato per scrivere i miei manuali. Voi ne avete scritti? E in che modo? Quali altri suggerimenti potete dare per chi voglia scrivere un manuale?