giovedì 15 gennaio 2009

Esercizio di riscrittura n° 1

Vi propongo un primo testo abbastanza ostico, che necessita di una riscrittura.

L'integrazione Like Real Time è una proprietà della maggioranza dei connettori disponibili per Global Control Identity Manager.
Si intende con Like Real Time il fatto che il singolo connettore effettui un polling a frequenza elevata (tipicamente tra i 5 secondi e il minuto e comunque configurabile) delle variazioni avvenute sul sistema integrato.
Questo modello viene applicato solo per i sistemi per cui è disponibile una forma di Change Sheet su cui rilevare direttamente le differenze.
In ogni caso implica l'assenza di snapshot e comparazione della stesse ma solo l'integrazione via API o protocollo standard alla forma di Change Sheet disponibile sui vari sistemi.

La modalità di integrazione Like Real Time permette di avere molte e frequenti elaborazioni delle sole variazioni eventualmente intercorse dall'ultima esecuzione.
L'esistenza della modalità di integrazione Like Real Time garantita dai connettori, permette di gestire sulla base puntuale della singola entry la propagazione delle eventuali modifiche senza dover effettuare comparazioni o elaborazioni massive.
Sul piano architetturale la presenza dell'integrazione Like Real Time svincola la performance del sistema dal numero di entità complessive gestite lasciando solo la dipendenza dal numero di entità nell'unità di tempo modificate.
Questo è rilevante in quanto molti sistemi di provisioning di altri vendor si basano sulla comparazione di snapshot successive prelevate dai sistemi periferici ad intervalli regolari o schedulati. La comparazione di snapshot successive determina l'elenco delle modifiche da consolidare.

Questo testo presenta diversi difetti: punteggiatura imprecisa, ripetizioni farraginose, periodi poco chiari e soluzioni inessenziali al fine dell'illustrazione di una modalità, denominata Like Real Time, utilizzata per verificare le variazioni dei dati contenuti in un sistema informatico.
Chiunque lo esamini, dovrebbe essere scosso da un fremito di ribellione creativa!
Di seguito, suddividiamo il testo in 4 parti e proviamo a riscriverlo.

------------------------------------

PARTE 1

L'integrazione Like Real Time è una proprietà della maggioranza dei connettori disponibili per Global Control Identity Manager.

Si intende con Like Real Time il fatto che il singolo connettore effettui un polling a frequenza elevata (tipicamente tra i 5 secondi e il minuto e comunque configurabile) delle variazioni avvenute sul sistema integrato.
Questo modello viene applicato solo per i sistemi per cui è disponibile una forma di Change Sheet su cui rilevare direttamente le differenze.

L'integrazione Like Real Time (LRT) è una proprietà della maggioranza dei connettori disponibili per Global Control Identity Manager.
Con il LRT, il singolo connettore effettua un polling a frequenza configurabile (tipicamente tra i 5 secondi e il minuto) delle variazioni avvenute sul sistema integrato, laddove il sistema preveda una forma di Change Sheet su cui rilevare tali differenze.

Nella PARTE 1, l'aggetivo elevata "sa di marketing"... rispetto a cosa la frequenza di polling sarebbe "elevata" ? Quello che invece è veramente importante sottolineare è che la frequenza è configurabile entro un certo intervallo.
Anche il termine direttamente non risulta essenziale alla comprensione del concetto che vogliamo comunicare.


PARTE 2
In ogni caso implica l'assenza di snapshot e comparazione della stesse ma solo l'integrazione via API o protocollo standard alla forma di Change Sheet disponibile sui vari sistemi.
La modalità di integrazione Like Real Time permette di avere molte e frequenti elaborazioni delle sole variazioni eventualmente intercorse dall'ultima esecuzione.
L'esistenza della modalità di integrazione Like Real Time garantita dai connettori, permette di gestire sulla base puntuale della singola entry la propagazione delle eventuali modifiche senza dover effettuare comparazioni o elaborazioni massive.

La modalità LRT permette di avere frequenti elaborazioni delle sole variazioni eventualmente intercorse dall'ultima esecuzione; l'analsi è incentrata sulla base della singola entry e consente la propagazione delle eventuali modifiche senza dover effettuare comparazioni o elaborazioni massive.

All'inizio della PARTE 2, la parte in rosso è semplicemente poco chiara e non è utile alla comprensione del lettore: ho eliminato l'intero periodo. Nella parte finale ho "asciugato" il testo ed eliminato qualche fastidiosa ripetizione, ricorrendo anche all'acronimo LRT al posto della locuzione estesa Like Real Time.


PARTE 3
Sul piano architetturale la presenza dell'integrazione Like Real Time svincola la performance del sistema dal numero di entità complessive gestite lasciando solo la dipendenza dal numero di entità nell'unità di tempo modificate.

Il meccanismo LRT svincola la performance del sistema dal numero di entità complessive gestite, enfatizzando solo la dipendenza dal numero di entità modificate nell'unità di tempo .

All'inizio del terzo brano, la parte in rosso viene sostituita dal più snello Il meccanismo LRT.


PARTE 4
Questo è rilevante in quanto molti sistemi di provisioning di altri vendor si basano sulla comparazione di snapshot successive prelevate dai sistemi periferici ad intervalli regolari o schedulati. La comparazione di snapshot successive determina l'elenco delle modifiche da consolidare.

I sistemi di provisioning di molti altri vendor, si basano invece sulla comparazione di snapshot successive, prelevate dai sistemi ad intervalli schedulati; la comparazione tra due snapshot successive determina le modifiche da consolidare.

Il fatto che i sistemi coinvolti siano periferici, nulla aggiunge alla comprensione del concetto di LRT.
La locuzione "regolari o schedulati" è fuorviante; la schedulazione implica la possibilità di definire intervalli, sia regolari che irregolari.
In altri termini "schedulati" implica anche "regolari", non sono concetti alternativi.


------------------------------------

Adesso, mettendo insieme le 4 parti riscritte, si ottiene un testo piu' asciutto, snello ed essenziale rispetto a quello di iniziale. L'attenzione ad "asciugare" e "snellire" i testi verrà ossessivamente perseguita in questa sede... siete avvertiti!
Ovviamente potevo seguire altri criteri nel riscrivere il testo e non è detto che la soluzione indicata sia in assoluto la migliore... ogni writer può seguire un approccio personale in tal senso. Il risultato finale mi sembra comunque migliore rispetto al punto di partenza... se avete tempo e voglia, fatemi sapere cosa ne pensate.




Leggi questo articolo...

lunedì 12 gennaio 2009

Come approcciare gli esercizi di riscrittura

Gli esercizi proposti in questa sezione, presentano la seguente struttura:
  • viene proposto un testo da riscrivere;


  • il testo viene suddiviso in N parti (in genere 3 o 4 parti);


  • ogni parte viene visualizzata in corsivo e subito dopo viene proposta la sua riscrittura;


  • dopo la riscrittura, in verde, viene illustrato un commento sulle soluzioni che sono state adottate;


  • in rosso sono indicate parole o frasi chiave, sulle quali viene posta una particolare attenzione ai fini della riscrittura.


Questo semplice schema può essere molto utile per migliorare l'efficacia della propria scrittura.
Provate a seguire questo metodo ed eventualmente inviate i vostri post con delle soluzioni alternative rispetto a quelle che vi propongo.
Non esiste un solo modo di riscrivere un testo e il mio punto di vista è, per l'appunto, il mio.
Buona lavoro! Leggi questo articolo...

sabato 10 gennaio 2009

La riscrittura del testo non è un optional!

L'attività di rilettura e di riscrittura di un testo non rappresenta un'opzione desiderabile da mettere in atto quando avanza un pò di tempo, ma DEVE essere prevista come un'attività fondamentale e strutturata, dalla quale dipende la qualità del risultato del nostro lavoro.

Ci sono esempi molto illustri, di grandi autori di ogni epoca, che hanno dedicato alla rilettura e riscrittura dei loro testi una parte importante della loro espressione creativa.

L'esempio scolastico più clamoroso è forse quello di Alessandro Manzoni, che arriva alla stesura definitiva dei Promessi Sposi in un periodo temporale che inizia nel 1821 e termina nel 1840!

Un ben più modesto TW deve affrontare tale problema disponendo di tempi generalmente più stretti... per fortuna!

Come ci si organizza ? Come spesso accade in questo mestiere, non ci sono regole fisse e infallibili.
Io adotto questo schema: una volta giunto alla stesura sostanzialmente definitiva, chiedo ad un collaboratore di rileggerlo e di proporre le sue modifiche.

Quando si lavora per diversi giorni su un manuale si rischia di non riuscire più a vedere nemmeno gli errori più palesi.
Poi cerco di dimenticarmi (se le scadenze lo consentono...) di quel testo per qualche giorno, quindi lo ri-esamino, valuto le correzioni/variazioni proposte e se le condivido le integro nel testo; dopodichè mi concentro sulla riscrittura delle parti che lo richiedono.

E per "riscrivere" intendo fondamentalmente "asciugare" il testo da tutti gli elementi inessenziali: via gli aggettivi ridondanti, eventuali ripetizioni, periodi che in origine mi sembravano utili a puntualizzare un idea ma che successivamente si rivelano superflui.

Quando decido di snellire il testo, vuol dire che comunque "già funziona", che c'è tutta "la ciccia" che serve.

Questo schema sembra molto semplice e lineare e per me funziona.

Con l'esperienza, l'abitudine alla rilettura diviene una specie di "palestra del cervello" che si attiva automaticamente anche durante la fase di prima stesura; questo automatismo non si acquisisce facilmente, ma non è nemmeno una dote naturale.

E' qualcosa che tutti possono sviluppare scrivendo molto e abituando la mente a riconsiderare il periodo appena riscritto, per coglierne immediatamente le eventuali disarmonie.

In tal modo, quando si applica lo schema sopraindicato, sono già stati sanati i problemi più macroscopici.

Quando scrivo documenti tecnici in lingua inglese, l'applicazione rigorosa di questo metodo di lavoro è ancora più necessaria.

In tal caso, oltre a quanto già indicato, bisogna porre particolare attenzione all'efficacia della traduzione e il tempo necessario ad ultimare il processo di riscrittura è generalmente maggiore.

Non cedete alla tentazione di pensare che quet'attività sia una perdita di tempo... risparmiare un giorno di lavoro per poi accorgersi di aver redatto un documento impreciso e poco chiaro, non rappresenta un gran guadagno, ve lo assicuro.
Leggi questo articolo...

mercoledì 7 gennaio 2009

TW... chi è costui ?

La citazione del Don Abbondio di Alessandro Manzoni mi sembra quanto mai adatta a descrivere lo stato d’animo dell’interlocutore di turno che mi chiede di cosa mi occupo nel mio lavoro.
Del resto … “ingegnere” è una parola che si capisce, ammantata anche da un alone di quasi-santità che tradizionalmente incute un certo timore.

Se dici in giro che sei un ingegnere, nessuno fa domande o corruga le sopracciglia, perché l’ingegnere, anzi “l’Ingegnere”… E’ ! Non c’è bisogno di argomentare, convincere, spiegare.

MA “TECHNICAL WRITER” ? E come glielo spiego ?


Questa figura professionale è in realtà molto comune nel mondo anglosassone e asiatico, soprattutto nell’ambito della produzione di beni e servizi ad alto contenuto tecnologico.
In altri termini, laddove nasce e viene prodotta la tecnologia, è necessaria la presenza di una figura professionale in grado di farsi carico delle esigenze di comunicazione, a diversi livelli, che ogni nuova tecnologia inevitabilmente richiede.

L’Italia è paese di santi, poeti, navigatori, artisti, intellettuali, evasori fiscali, raccomandati,… ma di innovatori tecnologici, purtroppo, specialmente negli ultimi 20 anni, abbiamo perso progressivamente le tracce.

Se questo è vero in molti campi, laddove le eventuali eccezioni confermano la collaudata regola, lo anche di più nell’ambito dell’Information & Computer Tecnology, ambito in cui l’Italia è tradizionalmente “provincia dell’Impero”.

A me è capitata la ventura di realizzare una tesi di laurea sperimentale nell’azienda che poi mi ha assunto e in cui mi trovo tutt’oggi; un’azienda “mosca bianca”, che produce tecnologia in un settore estremamente avanzato ed in cui la necessità di un’efficace comunicazione è divenuta non complementare o di supporto allo sviluppo del business, ma strutturalmente portante ai suoi fini.

In questi casi, come spesso accade, si prende un dipendente che fa intravedere una certa predispozione, che ha maturato una certa esperienza e capacità, che conosce i prodotti e i processi aziendali e gli si dice:
“QUESTA E’ LA PALLA…. GIOCA!”

Oddio… E GLI SCHEMI ? E L’ALLENAMENTO SPECIFICO ? E L’ESPERIENZA ?
Ma che diamine! Sei o non sei Ingegnere ? E QUINDI ONNISCENTE ?
Ma…veramente… magari bravino… ma, proprio proprio onniscente… no, … da dove si comincia ?

Voglio dire… dove si impara a scrivere documentazione tecnica ?
Quale sono i paradigmi, i riferimenti, gli stilemi ?
Come si diventa Technical Writer ?
Ma così cominciamo male.
Forse non è la domanda giusta da cui partire; prima bisogna domandarsi… cosa fa un Technical Writer ?

E se ci fosse una risposta univoca, sarebbe già un bel modo di partire.

Indovinato ? Non c’è!
E forse questo blog nasce anche per provare a raccontare in quanti modi si può dare questa risposta…
Leggi questo articolo...

domenica 4 gennaio 2009

Mi presento

Mi chiamo Alessandro Stazi, ho 42 anni e sono laureato in Ingegneria Informatica.
Fino al 2005 non avevo mai conosciuto un Technical Writer… poi lo sono diventato!

E lo sono diventato per far fronte alle esigenze dell’azienda in cui lavoro, che mi ha proposto di re-inventarmi in un ruolo inaspettato.

Bisognava riorganizzare completamente tutto il settore della documentazione dei prodotti aziendali, nonché re-impostare tutti i processi di produzione della medesima.

Elaborare nuovi contenuti, ridefinire standard formali, immaginare contenitori, ingegnerizzare i processi di raccolta e classificazione delle informazioni che poi conducono alla definizione di un manuale d’installazione, di una scheda tecnica o di un getting started.

Tutto questo…senza alcuna formazione specifica!

Del resto è noto che gli ingegneri non abbiano mai avuto molta confidenza con le lettere, anche se Carlo Emilio Gadda, in tal senso, ci riscatta tutti.

Dopo un lungo periodo in cui mi ero occupato dello sviluppo di progetti software incentrati sulle tecnologie crittografiche e sulla firma digitale, mi sono trovato davanti ad un nuovo orizzonte.

Avevo dalla mia solo una mai sopita passione per la letteratura, una certa facilità nello scrivere e una testardaggine che si esalta in modo insalubre quanto più l’asticella viene posta in alto.

Tutto quello che so l’ho imparato sul campo, approntando una soluzione dopo l’altra in base alla risposta che bisognava dare ad ogni singolo problema, correggendo la rotta quando necessario, imparando dagli errori e attingendo idee e schemi risolutivi da writers più bravi ed esperti di me, copiando dai migliori, frequentando i loro blog e leggendo quanto di più e di meglio potevo trovare in rete.

Dopo quasi 4 anni di lavoro e decine di manuali realizzati, comincio appena a rendermi conto di quanto devo ancora imparare, non avendo alle spalle una formazione specifica nel campo della Scienza della Comunicazione o equivalente ed essendo un’autodidatta nel senso letterale del termine.

Questo blog nasce anche per entrare in comunicazione con altri T-writers con i quali scambiare esperienze, nella speranza di accrescere i reciproci spettri di conoscenza, nella convinzione che 2+2 in certi casi possa fare 5... o 22... o 44!
Leggi questo articolo...

venerdì 2 gennaio 2009

Babele è un’opportunità… non una punizione.

« Tutta la terra aveva una sola lingua e le stesse parole. Emigrando dall'oriente gli uomini capitarono in una pianura nel paese del Sennaar e vi si stabilirono.
Si dissero l'un l'altro: "Venite, facciamoci mattoni e cuociamoli al fuoco". Il mattone servì loro da pietra e il bitume da cemento.
Poi dissero: "Venite, costruiamoci una città e una torre, la cui cima tocchi il cielo e facciamoci un nome, per non dispenderci su tutta la terra". Ma il Signore scese a vedere la città e la torre che gli uomini stavano costruendo. Il Signore disse: "Ecco, essi sono un popolo e hanno tutti una lingua sola; questo è l'inizio della loro opera e ora quanto avranno in progetto di fare non sarà loro impossibile. Scendiamo dunque e confondiamo la loro lingua perché non comprendano più l'uno la lingua dell'altro". Il Signore li disperse di là su tutta la terra ed essi cessarono di costruire la città.
Per questo la si chiamò Babele, perché là il Signore confuse la lingua di tutta la terra e di là il Signore li disperse su tutta la terra

(dalla Bibbia, libro della Genesi 11, 1-9)


Tra i racconti della Bibbia, il mito di Babele è certamente tra i più affascinanti.
L'interpretazione ortodossa di tale racconto, conduce all'idea che Dio punisce lo stolto orgoglio degli uomini, rei di voler costruire una torre alta fino al cielo, dando origine alle diverse lingue del mondo e impedendo in tal modo che i costruttori possano collaborare tra loro.

E ' la riproposizione, in altra veste, del mito di Prometeo, laddove il suo supplizio è certo più orribilmente cruento della punizione che il Dio giudaico infligge ai costruttori della torre.

Eppure io ho sempre voluto immaginare un'interpertazione diversa del mito di Babele, forse troppo personale ma magari più ottimistica.

Oggi la tecnologia ha reso il mondo molto più piccolo e i grandi flussi migratori che, come in un sistema di vasi comunicanti, portano masse di uomini a spostarsi dai paesi poveri a quelli più ricchi, ci impongono la necessità di misurarci con molteplici "diversità culturali", di cui la diversità linguistica è il segno più percepibile.

In qualche modo e nei diversi settori della società, come i costruttori della torre di Babele, siamo gomito a gomito, intenti a costruire una "torre di comunicazione" non meno ambiziosa, laddove "la diversità" può essere un'opportunità, un cemento, un moltiplicatore di civiltà... e non una punizone divina.

In questo contesto, chi ha la passione della scrittura e, per diletto o per mestiere, operando su piani diversi, si misura con "il gioco" della comunicazione, deve ogni giorno imparare una nuova regola, sperimentare una nuova idea, trarre lezioni da un nuovo errore, immaginare una soluzione più originale o reinterpretare schemi già collaudati.

Da tutto questo nasce l'dea di un Blog e il suo titolo, cioè di un luogo dove "un'artigiano" della parola prova a raccontare le sue esperienze e cerca di entrare in comunicazione con altri che coltivano la stessa passione o mestiere, per provare a crescere vicendevolmente, imparando gli uni dagli altri… perché la diversità delle conoscenze, delle idee, delle visioni…non sia un limite ma un’opportunità.


Leggi questo articolo...