domenica 29 marzo 2009

COSA FA il Technical Writer ? L'interazione con i tecnici

Nella realtà industriale spesso sono dei tecnici, generalmente degli ingegneri, a scrivere i manuali delle macchine o di un prodotto software.
MA SIAMO COSI’ CONFIDENTI CHE SIA LA SCELTA PIU’ OPPORTUNA ?

Il progettista è in genere la persona meno adatta a spiegare ad altri il funzionamento della sua opera; in altre parole, la sua competenza tecnica specifica non lo rende automaticamente un bravo scrittore-istruttore.
Per quanto controintuitiva possa sembrare tale affermazione, quanto più un tecnico risulta essere un vero specialista, tanto più avrà difficoltà ad adottare quel distacco essenziale per far emergere una visione d'insieme dell'argomento.
Leggi questo articolo...

sabato 28 marzo 2009

COSA FA il Technical Writer ?

Proviamo a rispondere a questa domanda delineando le diverse parti di un puzzle molto interessante.

Nell’accezione più schematica, il TW si occupa di scrivere manuali.
Questa prima indicazione, così formulata, potrebbe suonare estremamente riduttiva.
In realtà il TW è il tramite tra il prodotto e l’utilizzatore del medesimo.
Deve rendere comprensibile ciò che non lo è, quindi scrive per spiegare.

Si pone dalla parte dell’utilizzatore, usando il linguaggio più opportuno per spiegare il funzionamento di un software o di una macchina.
Leggi questo articolo...

sabato 14 marzo 2009

Soluzioni: uso degli elenchi.

Una delle situazioni più tipiche che mi è capitato di riscontrare nei documenti tecnici scritti in modo poco accorto, consiste nello scarso utilizzo degli elenchi (puntati e/o numerati) laddove sarebbero utili e necessari.
Consideriamo l'esempio seguente:

"...attraverso la console degli eventi è possibile controllare l'utente che ha effettuato una certa operazione, l'ora in cui è stata effettuata, il suo ruolo operativo registrato nel sistema, il dispositivo sui cui è stata effettuata, l'insieme degli eventi che sono stati scatenati dall'operazione, i dati coinvolti, le eventuali notifiche configurate..."

Che cosa abbiamo appena letto?
Niente di complicato... un semplice "elenco".
Leggi questo articolo...

venerdì 13 marzo 2009

CHI E' il Technical Writer ?

CHI E'... e COSA FA... il Technical Writer?

Sempifichiamo... iniziamo dal CHI E'. Per rispondere a questa domanda, ci si trova a dover superare ostacoli di non poco conto.

Il primo riguarda la “bassa densità” di questa figura nel panorama professionale italiano, dove spesso la figura del redattore tecnico è considerata erroneamente come una figura professionale di serie B.

Il nostro paese non riveste il ruolo di leader nella produzione di tecnologie innovative e di prodotti incentrati su di esse.

Il numero molto limitato, rispetto al mondo anglosassone o asiatico, di aziende che realizzano “prodotti”, influenza negativamente la promozione di figure specializzate nella redazione di documentazione tecnica.
Leggi questo articolo...

lunedì 2 marzo 2009

Soluzioni: uso delle tabelle.

Nella letteratura tecnica, l'uso delle tabelle può essere particolarmente efficace per comunicare le relazioni che intercorrono tra due o più entità.

Non siamo generalmente allenati ad esaminare una situazione, un contesto, una descrizione e a riconoscere la struttura relazionale dei diversi elementi in essa coinvolti.

Di contro, è molto comune trovarsi a leggere una descrizione estesa di un'insieme di relazioni che spesso conduce il lettore in un gorgo in cui annegare può sembrare il minore dei mali!

Un esempio? Eccolo:
Leggi questo articolo...