Come scrivere una guida tech nel modo corretto

Ogni scrivente esperto sa benissimo che una delle prime cose importanti per redigere un testo come si deve è sapere di che tipo di testo si tratta. Il tone of voice, il linguaggio e il lessico in generale vengono infatti definiti dal tipo di testo.

Un articolo di un blog sarà diverso da una guida tecnica, così una guida tech per persone già del settore sarà diversa da una guida per principianti. È proprio per questo motivo che chi ha un blog tech o intende scrivere una guida a questo tema deve adottare un particolare tipo di scrittura, di lessico e di impostazione.

Chi leggerà quella guida? Qualcuno di esperto o si intende destinarla a chi si approccia per le prime volte all’argomento? Nel dubbio è meglio spiegarsi sempre bene e dettagliatamente, non lasciando nulla al caso. Meglio dire troppo, che trascurare dettagli che possono mancare e non far risultare la guida poco chiara ed esaustiva.

Le 3 regole d’oro per una guida a tema tech ben fatta?

L’argomento già di per sé non è dei più semplici ed è per questo che, chi scrive di questo, deve utilizzare un modello chiaro, un lessico adeguato ed essere il più semplice possibile dove si può. Le procedure devono essere quindi ben scritte, incisive e snelle. I giri di parole, insomma, non sono adatti perché già con una letta si deve capire almeno a grandi linee quello che si è detto.

Ecco quindi la regola numero 1: semplicità, no alle deviazioni. Il testo va immaginato come un percorso da seguire, con un capo e una coda: parliamo di processi, infatti, non è un racconto di intrattenimento. Regola numero 2: il contenuto è una mappa dove ci si deve muovere agilmente. Non significa, ovviamente, che bisogna per forza fare un elenco a punti: se si vuole qualcosa di meno impattante e più discorsivo è possibile.

Una scaletta a punti, tuttavia, è utile per assicurarsi di buttare giù il testo in modo ordinato, senza dimenticare passaggi. Nel mondo tech, scordare, anche un piccolo passaggio può essere fatale, si sa. Una suddivisione a capitoletti, se il testo è lungo, consentirà di muoversi agevolmente nella guida.

In questo caso, sì che sarebbe meglio mettere un numero di ordine del capitolo, arricchendo magari con un titolo esaustivo che faccia capire che passaggio del procedimento si va a descrivere.

L’ultima regola (3), la più utile, ma forse la più difficile da applicare è quella di scrivere immaginandosi a leggere non sapendo nulla di quello che si sta scrivendo. Bisogna, sostanzialmente, immedesimarsi nel lettore, specialmente in quello che non ha competenze specifiche (se lo si vuole includere).

Technical Writing perfetto

Una guida tecnica non è un trattato letterario che viene valutato dall’Accademia della Crusca, tuttavia, una guida seria non comprende di certo banali errori grammaticali. Se ve ne sono, il testo (anche se utile magari) risulta essere poco attendibile poiché dà l’impressione di essere stato fatto in modo sbrigativo. Per evitare gli errori più comuni (ed i meno comuni!) si possono usare i siti di analisi grammaticale online.

Come funzionano? In linea di massima si inserisce il testo in una finestra apposita e il software lo scansiona alla ricerca degli errori grammaticali. È chiaro che corregge solo le sviste più evidenti, ma che non rende il testo perfetto se non lo è. Se è presente un termine corretto, benché inopportunamente all’interno della frase, potrebbe non segnalarlo. Per vedere bene gli errori si consiglia di rileggere il testo in un secondo momento. Appena scritto il testo, infatti, è davvero difficile rendersi conto se c’è qualcosa che non va.