Scrivere è comunicare

Il blog per scrittori, blogger e copywriter

Come scrivere un manuale

Come scrivere un manuale
Il mio metodo per scrivere manuali

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?

34 Commenti

  1. Chiara
    10 giugno 2014 alle 08:41 Rispondi

    Anche io ho scritto un manuale, in passato. Trattava della comunicazione interpersonale e l’ho utilizzato come dispensa in alcuni corsi. Concordo con te per quanto riguarda la progettazione: se per un romanzo non è necessario definire a priori tutti i punti della trama (proprio domenica ho pubblicato un post al riguardo su “appunti a margine”) credo che per la saggistica non ci si possa affidare all’ispirazione. Si tratta di esporre un argomento che si conosce bene, occorre essere preparatissimi e sapere dove si vuole andare a parare.
    Condivido anche gli altri punti di cui hai parlato eccetto, forse, la preparazione delle immagini: io ho fatto un lavoro differente e me ne sono potuta occupare tranquillamente in fase di editing.
    Buona giornata

    • Daniele Imperi
      10 giugno 2014 alle 13:18 Rispondi

      Ti sei occupata durante l’editing delle immagini?

      • Chiara
        11 giugno 2014 alle 11:39 Rispondi

        Si… una scelta strana, forse, ma non mi ha causato grossi problemi. Anzi: si è rivelata utile in quanto il testo era già definito, dunque avevo la certezza che fossero pertinenti

  2. ferruccio
    10 giugno 2014 alle 12:36 Rispondi

    Devo preparare quello sui serpenti velenosi, anche se l’idea di fondo è quella di seguire un po’ la tipologia di “Morte del pomeriggio” di Hemingway. Una via di mezzo tra manualistica e fiction. Però le indicazioni che hai dato sono ottime

  3. Michela Martini
    10 giugno 2014 alle 14:52 Rispondi

    Grazie Daniele per questo post che al momento ritengo esaustivo.
    Sono in fase di progettazione e ho cominciato da un elenco degli argomenti e poi, siccome sono pazza di Pinterest, con l’archiviare alcune immagini che senz’altro ci saranno nel manuale di feng shui che scriverò. A proposito d’immagini, dicevi di affidarsi a fotografi, grafici e disegnatori. Qualcuna me la preparerò sicuramente da me, soprattutto schemi e infografiche (che ne pensi dell’inserimento di un’infografica riepilogativa alla fine di ogni capitolo?), per quanto riguarda invece situazioni di ambienti da copiare o da evitare, avevo pensato di servirmi d’immagini trovate nel web, rispettandone i limiti di copyright. Che ne dici?

    • Daniele Imperi
      10 giugno 2014 alle 15:53 Rispondi

      L’idea dell’infografica riepilogativa è buona, però bisogna calcolare le dimensioni del manuale. Parlane prima con la casa editrice. Le infografiche sono di solito sviluppate in senso verticale e molto lunghe, non so quindi alla fine come sarà la resa.

      Ma non deve essere per forza strutturata come una classica infografica. Però è una bella idea.

      Le immagini nel web? Devi allora cercare immagini che puoi usare anche a fini commerciali – è un libro che viene venduto, quindi di commercio si tratta. E non basta, in quel caso, citare la fonte.

      • Michela Martini
        10 giugno 2014 alle 16:01 Rispondi

        Vero! C’è un particolare di cui non posso parlare adesso che mi ha fatto pensare alle infografiche, anche nella loro dimensione “normale”. Buona però l’idea di strutturarle secondo un’impostazione non classica.

        Ancora grazie per le informazioni. A presto!

    • Silvia
      12 giugno 2014 alle 19:15 Rispondi

      se sono prese dal web dovrai verificare la risoluzione. pochissime andranno bene stampate… hummnn.

      • Daniele Imperi
        12 giugno 2014 alle 19:38 Rispondi

        Ciao Silvia, benvenuta nel blog.

        La risoluzione buona per la stampa si trova solo nei siti che offrono foto ad alta risoluzione, appunto. Ma prima deve verificare se possono essere commercializzate.

        • Michela Martini
          13 giugno 2014 alle 00:16 Rispondi

          Dato l’uso che dovrò farne terrò conto prima di tutto di quanto suggerito da Daniele. La stampa è un problema risolvibile. Vi farò sapere. Grazie anche a Silvia.

    • Silvia
      16 giugno 2014 alle 06:18 Rispondi

      Daniele, una domanda per te: come faccio ad indagare i diritti delle foto che trovo gratuitamente su goggle? a chi chiedo?

      • Daniele Imperi
        16 giugno 2014 alle 07:51 Rispondi

        Allora, intanto diciamo che le foto non stanno su google :)

        Google ti mostra le foto prese dai siti in cui sono state pubblicate. Quindi, anche se cerchi su Google immagini, apri la pagina che contiene la foto e vedi se ci sono info al riguardo. Altrimenti scrivi al sito.

        Ma io ti consiglio, se ti servono foto per libri, ecc., di cercare sui siti che le vendono, primo perché le trovi ad alta risoluzione, poi perché è più sicuro che tu possa usarle.

  4. Laura Tentolini
    10 giugno 2014 alle 19:56 Rispondi

    Ciao,
    riporto una considerazione di Giulio Mozzi che mi aveva colpito.

    “Nella manualistica alla completezza delle informazioni devono aggiungersi la facilità di reperimento delle stesse, la chiarezza dell’esposizione, la definizione precisa delle competenze che si presumono già presenti nel lettore, eccetera.”

    Scrivendo “Vendere senza le parole” seguivo una serie di istruzioni su contenuto e formato ricevute dall’editore.
    Un manuale è un testo utile con un preciso obiettivo pratico:
    nulla è lasciato al caso!

    • Daniele Imperi
      10 giugno 2014 alle 20:53 Rispondi

      Ciao Laura,
      considerazione più che giuste. Non puoi improvvisare, ma devi calcolare ogni dettaglio.

    • Michela Martini
      11 giugno 2014 alle 07:15 Rispondi

      Ciao Laura,
      terrò in considerazione. Giulio Mozzi ha scritto un manuale su come scrivere un manuale? :)
      Grazie.

      • Laura Tentolini
        11 giugno 2014 alle 20:17 Rispondi

        Ciao Michela,
        non so rispondere alla tua domanda.
        Il realtà il brano di Giulio Mozzi che ho citato è uno dei “ritagli” che avevo collezionato quando stavo scrivendo il manuale.

        Una buona strategia, di solito, è studiare testi simili al nostro per vedere come sono strutturati. Io avevo letteralmente divorato parecchi manuali della Franco Angeli.

        Buon lavoro.

        • Michela Martini
          12 giugno 2014 alle 15:08 Rispondi

          Grazie Laura.
          Manuali di feng shui non ve ne sono molti, o meglio, non ve ne sono molti di fatti bene!

  5. Grazia Gironella
    11 giugno 2014 alle 11:58 Rispondi

    Sei stato molto chiaro ed esaustivo. Le mie esperienze in merito (sia il manuale di scrittura che il manuale tecnico per il personale dell’aeroporto dove lavoravo) corrispondono in pieno a ciò che hai detto. In particolare penso che sia utile domandarsi cosa si può offrire di particolare a chi legge. Il mercato è pieno di manuali di ogni genere su qualunque argomento. Se mi chiedo: perché leggere il mio testo e non un altro?, e trovo una risposta sensata, mi sento a buon punto.

    • Daniele Imperi
      11 giugno 2014 alle 16:27 Rispondi

      Vero, è pieno di manuali. E bisogna anche considerare che quello che scrivi nel manuale non è qualcosa che puoi trovare gratis online.

  6. Per quali lettori scriviamo?
    13 giugno 2014 alle 09:02 Rispondi

    […] in molti campi della scrittura si dice che bisogna conoscere il proprio pubblico. Se devo scrivere un manuale, come abbiamo visto martedì, devo per forza sapere a chi è diretto, perché da quel lettore tipo […]

  7. Severance
    16 giugno 2014 alle 03:58 Rispondi

    Aspetto a gloria un manuale (anche condensato) sulla gestione di una attività da scrittore/blogger che non sia infomarketing mascherato… Blog, profili sociali, promozione spicciola. Rientra nei tuoi progetti futuri? Più che altro una tabella di marcia sicura, organizzare il tempo è davvero difficile!

    • Daniele Imperi
      16 giugno 2014 alle 07:48 Rispondi

      Sì, è in progetto. Anzi, mesi e mesi fa avevo buttato giù una scaletta, ma è sicuramente da rivedere.

      Ci lavorerò senz’altro. Era però rivolta allo scrittore, non al blogger.

  8. Michela Martini
    25 luglio 2014 alle 19:41 Rispondi

    Ciao Daniele, sono in fase creativa ma ancora ben lontana dal poter dire: “sto scrivendo il manuale”. :)

    Mi stavo chiedendo se sia una buona idea, nel caso della versione ebook, inserire alcuni link a miei o altrui post di approfondimento riguardanti temi che nel manuale potrei affrontare in modo superficiale, perché il lettore medio potrebbe non essere interessato a scendere nel dettaglio. Un’operazione che potrebbe dare vita a una sorta di corollario.

    Che ne pensi?

    Grazie. Buon sabato.

    • Daniele Imperi
      25 luglio 2014 alle 20:10 Rispondi

      Ciao Michela,
      certo, fai bene, anzi. Io li metterei comunque, fra le risorse.

      • Michela Martini
        26 luglio 2014 alle 07:20 Rispondi

        Grazie della tua opinione.
        (Mi chiamo Michela…un giorno capirò perché l’80% delle persone che non mi frequentano abitualmente mi chiamano Martina :))

  9. Adriana
    8 maggio 2015 alle 14:38 Rispondi

    Grazie alle tue informazioni semplici e dettagliate, oggi anch’io neofita di manuali, mi accingo a scrivere IL MIO MANUALE DI….. infinitamente grazie, Adriana

    • Daniele Imperi
      9 maggio 2015 alle 08:11 Rispondi

      Ciao Adriana, benvenuta nel blog. Il tuo manuale di…? Su cosa è? :)

  10. Loredana
    25 ottobre 2016 alle 15:30 Rispondi

    Ho una domanda…. sto rivedendo i manuali dei software prodotti dalla ditta in cui lavoro… ho un grandissimo dubbio… l’indice!!!! nell’indice vanno numerati tutti i capitoli, sottocapitoli e sotto-sottocapitoli??? in un manuale posso arrivare fino a 6 livelli e vedere scritto nell’indice per esempio:
    2.1.1.5.3.8 Utilità………………………pag 18
    mi sembra un pò esagerato… è anche vero però che nel manuale tutti i capitoli sono stati numerati… però volevo evitare questa cosa anche nell’indice…

    • Daniele Imperi
      25 ottobre 2016 alle 15:53 Rispondi

      Ciao Loredana, benvenuta nel blog.
      6 livelli sembrano esagerati anche a me. Ma il problema non sta nell’indice, bensì nella struttura del manuale, che sarebbe da rivedere.

Lasciami la tua opinione

Nome e email devono essere reali. Se usi un nickname, dall'email o dal sito si deve risalire al nome. Commenti anonimi non saranno approvati.