Gli scrittori tecnici creano diversi tipi di documentazione, per esempio, manuali utente, documentazione API, guide “Come fare per” e così via. Ho scritto un articolo su come scrivere un manuale utente, quindi oggi ti parlerò della creazione di una guida ‘How to’.
Quando hai il compito di creare una guida il tuo primo passo dovrebbe essere la pianificazione. Ecco cosa dovresti fare:
Capire il tuo pubblico di riferimento
Quando inizi a scrivere la tua guida, dovresti capire chiaramente chi è il tuo pubblico di riferimento. Qual è la loro età, qual è il loro background e così via. Questo definirà lo stile della tua guida ‘How to’ al livello più fondamentale – la complessità del linguaggio usato, il numero di termini e molte altre caratteristiche.
Ricerca sul processo
Ti consiglio di leggere l’esperienza di altre persone nello scrivere guide ‘how-to’. Ti aiuterà ad avere un’immagine chiara del lavoro futuro, e potrai integrare gli approcci degli altri nel tuo processo di lavoro. Per esempio, ho scritto sul processo di scrittura tecnica di Amrute Ranade, puoi leggere l’articolo qui: ‘Great Technical Writing Process’. Quindi, puoi anche usare questo metodo per facilitare la tua scrittura tecnica.
Raccogli materiali utili
Prima di iniziare a scrivere, raccogli materiale e informazioni che ti aiuteranno a scrivere una guida ‘how-to’. Possono essere informazioni aggiuntive su un prodotto, altre guide ‘how-to’ su prodotti simili o qualcos’altro.
Scrivi la tua guida ‘How-to’
Prima di tutto, crea un piano – sarà più facile scrivere una guida se la visualizzi. Dopo tutti questi preparativi, è il momento di iniziare a scrivere. Mentre crei una guida, dovresti tenere a mente i seguenti consigli:
- Scrivi in inglese semplice per parlare la stessa lingua dei tuoi lettori.
- Il tuo linguaggio dovrebbe essere sempre conciso (es, ‘Seleziona l’opzione’ invece di ‘Dovresti selezionare l’opzione’).
- Crea liste numerate per strutturare i passi se un utente deve completarli
- Aggiungi contenuto visivo come foto, screenshot e diagrammi.
- Dividete il contenuto in sezioni intestate ma scrivetele chiaramente
- Se volete usare battute, fate attenzione: la gente potrebbe non capirvi
- Aggiungete mini-TOC per rendere più leggibili i grandi argomenti.
Il consiglio più essenziale è il seguente – gli errori di ortografia e grammatica sono inaccettabili nella documentazione, quindi controllate accuratamente la vostra guida. Qui c’è una lista di Top Free Grammar Checkers. Inoltre, puoi chiedere a qualcun altro di correggere le bozze per te, o leggere i tuoi passi al contrario per essere sicuro che la tua scrittura sia chiara e semplice. Qui ci sono un paio di altre risorse per scrivere grande documentazione:
- Grammar Books for Technical Writers
- Style Guides for Technical Writers
Ovviamente, questo non è tutto quello che c’è da sapere sullo scrivere guide ‘How to’, ma questi suggerimenti sono i più essenziali, a mio parere. Spero che ti aiutino.
Buona fortuna con le tue guide di scrittura!