Iniziamo il 2012 evitando gli errori più banali

Per iniziare bene il 2012, ecco una collezione di errori da includere nella nostra Black List ideale.

Ce la offre una società statunitense, la Writing Assistance Inc. (WAI), che fornisce servizi di comunicazione tecnica ad ampio spetttro. Il sito Web della WAI è interessante e mi riprometto di fornirvi una breve recensione quanto prima.

Ed ecco 7 errori da tenere a mente, perchè questo è proprio lo spirito di una BL: tutto ciò che c'è nella BL, semplicemente non va fatto!

ESSERE IMPRECISI

Spesso vi ho raccontato che la Qualità è nei dettagli e sembra che anche in WAI siano d'accordo con me.

NON USARE UN TEMPLATE
In molti pensano di saper usare i software di video-scrittura, ma quando apri un loro documento ti rendi conto che non usano formattazioni di alcun tipo e nemmeno gli stili predefiniti, ignorano i margini, l'interruzione di pagina ed il correttore ortografico ma, soprattutto, improvvisano qualsiasi tipologia di documento e non utilizzano alcun Template ben definito... Risultato? Documenti inguardabili, di difficile lettura, male organizzati nello stile e nei contenuti. Che vi posso dire? Come recitava Nanni Moretti in un celeberrimo film: "... continuiamo così... facciamoci del male...". Prossimamente vi dirò dove potete trovare migliaia di Template scaricabili gratuitamente... se imparerete ad usarli, capirete la differenza.

IGNORARE IL LETTORE

Nella comunicazione tecnica si scrive per spiegare concetti complessi a qualcuno, quindi il lettore e le sue esigenze dovrebbero essere il fulcro della nostra impostazione; quando ciò non accade, i risultati difficilmente saranno apprezzabili.

SCRIVERE SENZA UNA PIANIFICAZIONE

E' il modo migliore per sprecare tempo ed energia. Raccogliere i dati grezzi, classificarli, disegnare una mappa mentale degli argomenti fondamentali, abbozzare un indice, iniziare una prima stesura, verificare lo schema iniziale e magari modificarlo, estendere o limitare lo sviluppo di una o più parti rispetto alla prima stesura... e altro ancora. Una pianificazione è sempre necessaria; una o più riletture, magari con l'aiuto di una check-list, sono indispensabili, difficilmente è "buona la prima", a meno che non siate dotati di una genialità esasperata. E poi si può diventare più ambiziosi e pianificare altri aspetti della produzione della documentazione aziendale o del suo processo di validazione. Lavorare ignorando tutto ciò equivale a svuotare il mare con il cucchiaio... tutto sommato non molto divertente!

USARE LE CONTRAZIONI (E GLI ACRONIMI)

A volte l'uso di sigle contratte ed acronimi è inevitabile ma è buona norma non abusarne.

FARE DELLE ASSUNZIONI TROPPO FORTI

Talvolta polemizzo non poco con i miei colleghi tecnici i quali sostengono che "... questo non c'è bisogno di spiegarlo troppo nei dettagli, tanto si capisce... e poi chi legge questo documento è un utente esperto...".

Chi, a fronte della difficoltà che deve essere affrontata nella divulgazione di un concetto complesso si nasconde dietro queste tesi, cerca semplicemente di non farsi carico della suddetta difficoltà.
Salvo poi imprecare contro la scarsa chiarezza della documentazione disponibile quando sono "loro" a trovarsi dall'altra parte della barricata!
Un buon manuale non deve partire dall'ipotesi che il lettore sia un super-esperto. Certi documenti, come i Manuali di Installazione o le Check-List di Collaudo, devono essere addirittura "a prova di scimmia". 

CORREGGERE DA SOLI I PROPRI SCRITTI
E' l'errore più frequente, spesso indotto dal fatto di non disporre di un aiuto, di "un altro paio di occhi" che possano esaminare i nostri scritti. Con l'esperienza e l'allenamento si tende a sbagliare meno, ma difficilmente si rilevano tutti i prorpi errori, specie se si trascorre molto tempo su un documento. Quando è possibile, fate rileggere i vostri documenti a qualcuno di cui vi fidate e sarete sorpresi dalle correzioni che vi erano sfuggite!

BUON 2012 a tutti!

Condividi

Articoli correlati per categorie