Come Scrivere Un Buon Manuale Tecnico

Published at January 7, 2021 – 9 min read

Le 4 fasi per scrivere il libro tecnico

Per alcune persone pubblicare un libro rappresenta un sogno: significa condividere una particolare conoscenza. Nei libri narrativi, in cui dietro ad ogni storia, esiste una morale, spesso celata e non sempre facile da capire.

Nei libri più “tecnici” (in inglese technical books) è diverso: si tratta di qualcosa di più di una semplice condivisione. Scrivere libri per tecnici vuol dire essere un punto di riferimento in un particolare topic. “Cosa succede se..”, “Come si fa a..": queste sono le domande probabili dei tuoi lettori per cui vorranno leggere la tua risorsa.

Partiamo dall’inizio. Condividere un prodotto su cui hai dedicato tempo e soldi è gratificante. O almeno per me, lo è stato. Ho pubblicato il primo libro tecnico (e non l’ultimo) Mastering Monero nel Dicembre 2018, con il Self Publishing di Amazon e un team di persone eccezionali. È stato emozionante ricevere i primi feedback dei lettori che elogiavano sia il contenuto che lo stile di scrittura.

D’altra parte è stato un percorso intenso e difficile: scrivere un libro non è semplice e richiede tempo, molto tempo. Ho passato molti giorni (e anche qualche notte) ad immaginare, perfezionare e a riscrivere il contenuto, senza una casa editrice e pensando anche ad altri aspetti come il marketing.

Ho pensato che potesse essere d’aiuto scrivere un articolo con alcune tappe obbligatorie per un aspirante scrittore. Seguendo alcuni pochi semplici consigli (inizialmente ignorati anche dal sottoscritto), potrai goderti un po' di più della pazza avventura che andrai ad affrontare: scrivere il tuo primo libro tecnico!

Nei paragrafi successivi andremo ad affrontare:

  • la scelta dell’idea: riguardo cosa vuoi scrivere?
  • la scelta del pubblico: come lo vuoi scrivere?
  • scrivere la Table of Contents;
  • raggiungere gli editori;

Scegli l’Idea: Scrivere riguardo X, Y o Z

“Ho un’idea.. scriverò un libro su X”. Se questo è ciò che hai pensato stamattina dopo una colazione con un buon caffé, ti fermo. Un qualsiasi contenuto, specialmente un libro, richiede una certa competenza sull’argomento. Non ti limiterai infatti a padroneggiare l’argomento, ma dovrai anche spiegarlo ai tuoi lettori.

“Se c’è un libro che vuoi leggere, ma non è ancora stato scritto, devi scriverlo.”

Toni Morrison

Scrivere ciò che sai realmente e su cui hai speso settimane, mesi o addirittura anni della tua vita rende la scrittura più veloce e più facile poiché non dovrai fare tante ricerche. Sembrerà anche più autorevole.

Ciò che scoprirai è che nello spiegare l’argomento potresti dover imparare l’argomento in modo più dettagliato e fornire del materiale di supporto a tutti i nuovi arrivati. In realtà, in questo modo, diventerai ancora più esperto.

Scegli l'idea giusta e approfondisci

Chiediti anche: esistono già altri libri sull’argomento X? Perché dovresti scriverlo proprio tu? Queste sono alcune domande a cui dovrai rispondere sin dall’inizio della tua avventura. Potresti essere titubante, ma la determinazione conta molto!

Se vuoi solo scrivere quel libro che hai sempre sognato, e il successo commerciale non è una delle principali preoccupazioni per te, allora vai avanti e scrivi semplicemente quello che vuoi! Non c’è niente di sbagliato in questo approccio. Molti autori iniziano scrivendo sull’argomento a cui sono più interessati. L’esperienza di scrivere il tuo primo libro è inestimabile, sia che tu ne venda 10 o 1000 copie!

Identifica il Pubblico

Senza un pubblico, non hai alcuna prospettiva sul problema che il tuo libro sta risolvendo se non la tua esperienza. È vero che dovresti sempre cercare di risolvere prima i tuoi problemi, ma per avere successo devi risolvere i problemi degli altri nel processo. Se non stai risolvendo il problema di qualcuno con il tuo libro, non lo compreranno.

Inoltre non avresti nessuno a cui vendere il tuo libro. Sì, puoi mettere in vendita il tuo libro sul tuo sito web o su Amazon e potrebbe venderne alcune copie, ma avere un pubblico è fondamentale per il successo della pubblicazione di un libro.

Trova il giusto lettore

Non è necessario avere un grande mercato: non deve essere di milioni per ottenere un contratto per un libro, ma dovrebbe esserci un numero sufficiente di potenziali acquirenti per rendere il libro redditizio per te e per l’editore.

Il pubblico inoltre imposta il metodo di comunicazione per condividere la tua esperienza e conoscenza. A meno che tu non sia un professore universitario con più di X anni di esperienza, evita di creare un libro puramente teorico. Altrimenti i tuoi lettori si spaventeranno!

Gli ingegneri sono alla ricerca di informazioni e conoscenze attuali da poter utilizzare ora per risolvere i problemi. Va bene includere la teoria pertinente ma mantenerla breve e semplice. Ricorda: scrivi del contenuto che qualcuno possa utilizzare immediatamente.

Fornisci esempi e trova soluzioni. Se non sei un professore, ignora l’idea di un testo universitario. Ottenere un testo adottato per un corso è un risultato vincente ma raro. Inoltre, per un libro di testo, la maggior parte degli editori non ti parla nemmeno a meno che tu non abbia un dottorato di ricerca o usi il professore come titolo.

Scrivi la Table of Contents o il Sommario

Un buon modo per iniziare a scrivere il contenuto è abbozzare il tuo libro. La tua proposta dovrebbe includere un paragrafo riassuntivo del contenuto, una definizione del tuo pubblico previsto, una dichiarazione della necessità e del potenziale e uno schema provvisorio del titolo del capitolo.

Questo è ciò che un potenziale editore vuole vedere. Molti vorranno anche vedere la prefazione e un capitolo campione solo per valutare la tua capacità di scrittura e il tuo stile. L’intero esercizio ti fornirà una proposta per sollecitare gli editori, ma rafforzerà anche le tue idee.

Scrivere libro tecnico

Un altro consiglio: non reinventare la ruota. Trova il maggior numero possibile di altri libri e articoli sul tuo argomento e generane un elenco. Sii esaustivo e scorri (se non leggi completamente) tutte queste fonti.

Inoltre, stila un elenco di cose che non vuoi esplicitamente trattare. Controlla il tuo elenco di cose che non ti piacciono degli altri libri. Evita l’impulso di iniziare a scrivere su argomenti che inizialmente ritieni interessanti a meno che non pensi a quanto sia rilevante per il tuo progetto. “Sarebbe bello se …” è un pensiero su cui dovresti essere scettico.

Ad esempio, se un libro tratta del framework Bootstrap, potrebbe non essere necessario un introduzione sulla storia dell’HTML o su come il DNS funziona. D’altra parte, l’introduzione a CSS e alle regole di stile potrebbe essere una buona sezione da includere nel tuo libro.

Quando hai completato una ricerca sufficiente per sviluppare le tue idee, puoi utilizzare uno schema per sviluppare una bozza del tuo rapporto. Mentre scrivi e rivedi, continuerai a compilare i dettagli, aggiungere transizioni e fornire la tua comprensione acquisita dell’argomento.

Una volta che hai una qualsiasi bozza, non guardarla per alcuni giorni prima di leggerla di nuovo. Questo semplice trucco ti dà una visione più imparziale della tua scrittura e probabilmente scoprirai lacune e miglioramenti che avevi trascurato la prima volta.

Tieni presente che questo è uno schema di lavoro e non un contratto; man mano che prosegui la tua ricerca, potresti decidere di organizzare il rapporto finale in modo diverso e persino eliminare alcune informazioni e aggiungere nuove sezioni.

Contatta potenziali editori

Pubblica il tuo libro tecnico

Se segui il modello tradizionale della pubblicazione di un libro, ovvero con una casa editrice, questa sezione fa per te. Una volta che hai un argomento specifico per un libro e una discreta quantità di contenuti, è il momento giusto per parlare con un editore.

Dai un’occhiata ai libri sul mercato che sono simili a quello che stai scrivendo per scoprire i nomi degli editori interessati al tuo argomento. Quindi vai al loro sito web o contatta un editore di quella casa editrice e ottieni il modulo di proposta del libro. Gli editori generalmente fanno le stesse domande, anche se in un ordine diverso.

Una buona proposta generalmente include:

  • la tua idea – fornisci una breve panoramica dell’argomento che pianifichi e di come vuoi affrontarlo. Assicurati di scrivere il sommario costruito sopra con tutti i capitoli chiave. Come sempre, non importa se lo cambierai in seguito, ma questo aiuta a rendere la tua idea più concreta per le persone che la esamineranno.

  • il mercato – devi spiegare loro perché il tuo libro è una buona idea. Specula un po' sul mercato potenziale e comunica perché sei il miglior autore possibile per scrivere il libro. Il tuo obiettivo è convincere gli editori della tua idea! Includere anche gli anni di esperienza e alcuni eventi che hanno segnato la tua carriera potrebbe aiutare!

  • un esempio di scrittura – per scrivere un libro, devi mostrare al tuo editore che puoi scrivere in maniera corretta. Dato che gli editori baseranno la loro opinione sul tuo campione, evita errori grammaticali o semplici typo. Da un qualsiasi testo, potrebbero capire quanto tu possa essere effettivamente interessato a pubblicare un libro con loro!

Oltre a ciò che hai incluso nella lettera di presentazione, la maggior parte vorrà conoscere come potresti commercializzarlo (ad esempio, blog, siti web, radio). E con “come potresti pubblicizzarlo”, intendo dire che spetterà principalmente a te promuovere il tuo libro.

Invia la tua proposta insieme a una lettera di presentazione ai potenziali editori. Ce ne sono molti, soprattutto piccoli. O’Reilly, NoStarch, Packt. Scriverò più avanti un articolo riguardante le migliori case editrici che secondo me hanno un grande potenziale.

In ogni caso, non accettare mai il rifiuto. Un altro segreto è che spesso non ha nulla a che fare con la qualità del tuo libro o delle tue idee. Molti rifiuti riguardano le decisioni commerciali di un editore e non hanno nulla a che fare con te o con la tua scrittura.

Non sarai il primo! Anche le proposte di moltissimi scrittori sono state rifiutate. Sapevi che la serie di Harry Potter di JK Rowling è stata rifiutata da 12 editori? Agatha Christie ha lottato per cinque anni prima di ottenere il suo primo contratto editoriale! Anche tu potresti avere tanto tempo prima di ottenere un buon contratto (no, all’inizio non sarai come Agatha Christie :( ).

Attualmente, ho mandato circa 3 diverse proposte a ben 5 case editrici diverse e soltanto una di queste mi ha risposto che era interessato! Ma per questo, non ho mai messo di scrivere. L’ultimo consiglio che ti lascio è quello di continuare a scrivere e di migliorare la tua scrittura. Parafrasando “The noblest pleasure is the joy of understanding”, perché non scrivere qualcosa per condividere questa conoscenza?

Mi sono dimenticato di qualcosa? Vuoi avere un parere tecnico sul tuo libro? Puoi contattarmi a [email protected].

Illustrazioni composte da Andrés. – Ultimo aggiornamento il April 12, 2021

About

I am a security researcher, a writer, and contributor to the Monero project, a cryptocurrency focused on preserving privacy for transactions data. My publication Mastering Monero has became one of the best rated resources to learn about Monero. More about me

Follow me on Twitter or send me an email. I also appreciate donations, they allow me to continue doing my work and writing.

Mastering Monero book