Voglio diventare... Technical Writer

Scrivere è una passione, ma anche una palestra per migliorare professionalmente: Antonio Musarra, Software Engineer, ci racconta come è diventato Tech Writer.

Descriviti in 100 parole

La mia passione per il Technical Writing è nata sui banchi di scuola superiore, quando i miei compagni richiedevano sempre i miei appunti e i miei compiti venivano utilizzati come esempi dai professori, in particolare quello di elettronica e telecomunicazioni.

Dicono che ho sempre avuto un talento per spiegare concetti complessi in modo chiaro e conciso.

Circa 15 anni fa ho aperto il mio blog personale, che è stato e che è la mia palestra per migliorare la scrittura tecnica. Il mio motto, “I have always believed that knowledge sharing is a great tool for personal growth”, guida il mio lavoro. Oggi, come Technical Writer, cerco di trasformare informazioni complesse in documenti accessibili e chiari per i miei lettori.

In cosa consiste il ruolo di Technical Writer

Premetto che il ruolo di Technical Writer non è il mio lavoro e lo porto avanti esclusivamente per passione, ragion per cui cercherò di spiegarti la mia idea in merito.

La prima cosa è pensare ai lettori considerando che le skill di questi siano le più variegate, per questo motivo l’obiettivo principale è cercare di creare contenuti che siano chiari, concisi e facilmente comprensibili. Il tipo di contenuto include: articoli tecnici (per il web e la carta), manuali d’uso, guide per le API, white papers e altri materiali di supporto tecnico.

Alcuni delle persone che scrivono articoli tecnici hanno l’obiettivo primario di raggiungere un buon posizionamento su Google; il mio, al contrario, è che l’opera pubblicata sia in grado di soddisfare chi legge.

Cercherò di spiegare attraverso un semplice flow, com’è organizzato il mio lavoro affinché un nuovo articolo tecnico possa vedere la luce.

1. Identificazione Tema
   Determino l’argomento dell’articolo tecnico, identificando il problema da risolvere o il concetto da spiegare. Questo passo include la comprensione del pubblico target e degli obiettivi dell’articolo. Il più delle volte le idee per i nuovi contenuti prendono vita anche chiacchierando con i propri colleghi o durante le conferenze; gli input possono essere di varia natura.
2. Ricerca e Raccolta Info
   Raccolgo le informazioni pertinenti tramite documentazione esistente, interviste con esperti, esperimenti, o analisi di dati. Mi accerto che tutte le fonti siano accurate e aggiornate.
3. Pianificazione (outline e struttura)
   Creo una struttura dell’articolo, delineando i principali punti da trattare. Definisco l’ordine logico dei contenuti e decido come suddividere il testo in sezioni e sottosezioni.
4. Realizzazione di una POC
   Per il genere di articoli che scrivo, questi sono sempre corredati da un progetto software che si evolve insieme al lettore durante la lettura. Questo progetto è poi pubblicato su GitHub.
5. Stesura del Draft
   Scrivo la prima bozza dell’articolo basandomi sull’outline, concentrandomi sul trasferire le idee principali nel documento senza preoccuparmi troppo della perfezione formale.
6. Revisione ed Editing
   Rivedo il draft, migliorando la chiarezza, la coerenza, e la precisione tecnica. Correggo gli errori grammaticali, riformulo le parti poco chiare e mi assicuro che il contenuto sia ben strutturato.
7. Feedback e Iterazione
   Condivido il draft con colleghi, esperti o miei affezionati lettori per ottenere feedback. Metto in campo i suggerimenti ricevuti e apporto ulteriori miglioramenti al documento.
8. Formattazione
   Applico stile e formattazione in base alla destinazione del contenuto, destinazione che potrebbe essere: web, eBook o carta stampata. Questo include l’uso di titoli, paragrafi, elenchi, tabelle, immagini, e codici.
9. Pubblicazione e Diffusione
   Pubblico l’articolo nella piattaforma designata, che potrebbe essere un blog, un portale di contenuti tecnici, un blog aziendale, un portale di documentazione, o un altro canale.
10. Aggiornamento Continuo
    Monitoro l’articolo nel tempo per assicurami che rimanga rilevante e accurato. Aggiorno i contenuti quando necessario, ad esempio a seguito di cambiamenti tecnologici o feedback degli utenti.

Qual è la soft skill più importante che deve possedere un Technical Writer?

Le più importanti a mio avviso sono due e sono quelle che cerco di coltivare: Capacità di tradurre concetti complessi ed Empatia con il lettore.

Espandendo la prima, potrei dire che: i temi trattati sono spesso altamente tecnici, è essenziale saper spiegare concetti complicati in modo accessibile per un pubblico che potrebbe non avere una conoscenza approfondita di tutte le tecnologie trattate.

Espandendo la seconda, potrei dire che: comprendere le esigenze e i livelli di conoscenza dei lettori è cruciale. Un buon Technical Writer deve essere in grado di mettersi nei panni del lettore e anticipare le sue domande o difficoltà.

Altre soft skill importanti includono l’attenzione ai dettagli, la capacità di collaborare con team diversi e l’adattabilità a nuovi strumenti e tecnologie. In definitiva, la chiarezza nella comunicazione è fondamentale.

La maggior parte di noi utilizza i social per parlare dei propri successi, ma la realtà è che siamo quel che siamo grazie al 90% dei nostri errori. Racconta il tuo più grande fallimento da quando lavori nel settore, che però ti ha reso ciò che sei.

Una cosa che dico sempre e chi mi conosce lo sa benissimo: i contenuti devono essere sempre testati, come per il software, occorrono gli unit-test.

Quando vengo meno a questo, l’errore è sempre dietro l’angolo e quando poi è un tuo lettore che lo fa notare è il peggio che possa capitare. Di errori ne ho fatti di vario tipo e ne continuerò a fare. In questo contesto faccio sempre riferimento a Winston Churchill il quale disse: “Il successo non è definitivo, il fallimento non è fatale: è il coraggio di continuare che conta.” Commettere errori è quindi parte del processo di chi affronta la scrittura tecnica.

Come fare per diventare un Technical Writer?

Ho una formazione tecnica, abbracciando il “pezzo di ferro” (come mi piace chiamare l’hardware) fino al software che lo controlla. Al tempo di quando iniziai quest’avventura, mi resi conto, a forza di errori, che mi mancava una competenza alquanto fondamentale: abilità di scrittura e comunicazione tecnica.

Per sviluppare l’abilità nella scrittura e la comunicazione tecnica, ho letto diversi libri e seguito diversi corsi e per fare pratica ho iniziato a scrivere documentazione tecnica per progetti personali, open-source, o per piccole aziende.

Scrivere manuali, guide utente, o documentazione API è un ottimo modo per migliorare le proprie abilità.

Volendo fare un sunto, per diventare un buon Technical Writer serve:

1. Acquisire Competenze Tecniche
2. Sviluppare Abilità di Scrittura
3. Networking e Esperienza
4. Mantenersi Aggiornati

Il mio personale motto, che mi segue fin dai banchi di scuola (superiore), riportato anche sul mio profilo GitHub recita: “I have always believed that knowledge sharing is a great tool for personal growth”. Questo, insieme alla passione per la scrittura tecnica sono stati fondamentali per l’inizio della mia avventura da Technical Writer.

Parlando di successi, qual è il tuo prossimo obiettivo? Quale ruolo vorresti ricoprire entro i prossimi 3 anni?

Come ho detto prima, l’attività di Technical Writer è una passione e il mio prossimo obiettivo, direi continuo, è sempre quello di soddisfare i miei lettori, che magari incontrerò “di persona, personalmente” (come direbbe Montalbano) andando alla varie conferenze e da cui riceverò un semplice grazie per i contenuti pubblicati nel corso del tempo.

Spero nei prossimi anni di riuscire a pubblicare contenuti di un certo interesse, mantenere una certa frequenza di pubblicazione e ampliare i blog su cui pubblicare.

Conosci il tema gender gap in ambito STEM? Se sì, come fare per superarlo?

Questo è un tema che conosco in maniera più consapevole da quando ho iniziato a lavorare ma che in realtà ho vissuto fin dalle scuole superiori (ITIS Archimede di Catania). Le cause del gender gap in STEM sono complesse e includono stereotipi di genere, mancanza di modelli femminili, barriere culturali, differenze nell’accesso all’istruzione e discriminazione diretta o indiretta.

Certamente non ti posso dare una soluzione di tipo binaria (on => off), è un processo a lungo termine che richiede cambiamenti culturali profondi, ma che può portare a un settore STEM più equo e innovativo.

Dalla mia esperienza lavorativa degli ultimi 10 anni, vedo che le aziende per cui ho lavorato e lavoro tutt’ora sono molto attente al tema promuovendo varie iniziative e questo mi sembra un buon punto d’inizio.

Nell’ambito della scrittura tecnica vedo sempre più contenuti di qualità prodotti da donne e anche una marcata crescita di loro interventi in conferenze di settore. A mio avviso, step-by-step, anche questo settore diventerà sempre più equilibrato.