Era da tempo che volevo segnalarvi questo post di Giulia Zanchi, una Tech Writer e blogger dotata di una stile di scrittura che mi ha catturato fin dal primo incontro... digitale s'intende!
Nel post riassume ed elenca tutta una serie di fosforiche ed ironiche informazioni sulla nostra comune professione.
E' un esercizio di stile da manuale: le stesse informazioni che su certi siti "professionali" sono presentate su un sub-strato di noia fulminante, che ammazzerebbe anche un cavallo da tiro ungherese, scorrono con ritmo e piacevolezza, sono colorate, dinamiche e divertenti, senza la pretesa enciclopedica di voler spiegare tutto ma con un taglio inusuale.
Il suo blog non parla solo di T-writing, non è un blog tecnico in senso stretto, ci potete trovare anche altro e mi piace anche per questo.
E con ciò, serena Pasqua a tutti.
P.S.
Il mese di Marzo è stato un mese intensissimo sul piano lavorativo, mi ha lasciato poco tempo per scrivere sul blog, ma spero di recuperare nel mese di Aprile.
Leggi questo articolo...
domenica 31 marzo 2013
mercoledì 27 febbraio 2013
Iper Glossario!
Per chi scrive documentazione tecnica, contenuti web, per i traduttori e i localizzatori, uno degli strumenti più utili, da sempre, è il Glossario.
Ma quale Glossario? Ogni ambito tecnologico, ogni area culturale, ogni settore linguistico ha "il suo" Glossario.
E allora ben venga un sito che li colleziona: Glossarissimo.
L'iniziativa è di Stefano Kalifire, un traduttore professionista che segue da tempo il mio blog (ed io periodicamente vado a curiosare nei suoi). Sono andato un po' a zonzo e ho scoperto dei Glossari "inaspettati", vi invito a darci un occhio, magari trovate proprio quello che stavate cercando. Leggi questo articolo...
Ma quale Glossario? Ogni ambito tecnologico, ogni area culturale, ogni settore linguistico ha "il suo" Glossario.
E allora ben venga un sito che li colleziona: Glossarissimo.
L'iniziativa è di Stefano Kalifire, un traduttore professionista che segue da tempo il mio blog (ed io periodicamente vado a curiosare nei suoi). Sono andato un po' a zonzo e ho scoperto dei Glossari "inaspettati", vi invito a darci un occhio, magari trovate proprio quello che stavate cercando. Leggi questo articolo...
domenica 24 febbraio 2013
Dalla scrittura monolitica alla scrittura modulare: terza parte
Nel post precedente, abbiamo iniziato a concepire l'idea che possano esistere, in qualche modo, i "contenuti puri", modulari, scorrelati da una qualche forma. Ma ora come la sfruttiamo questa idea?
Per entrare nel vivo, immaginiamo un caso d'uso concreto.
Abbiamo un prodotto generico, che deve essere accompagnato da un set di documenti di vario tipo. Poniamo che il numero complessivo di documenti sia pari a 12.
In tutti questi documenti potrebbero esistere dei contenuti informativi condivisi. Ad esempio, il Glossario dei termini tecnici e degli acronimi. Oppure la Bibliografia. O magari la definizione delle Licenze di parti specifiche contenute nel prodotto ma realizzate da terze parti.
Per qualche motivo, tutte queste parti devono essere presenti in tutti i 12 documenti.
Nella figura seguente, identifichiamo il Glossario con il rettangolo rosso, la Bibliografia con quello giallo e le Licenze con quello verde:
Dovendo modificare il Glossario, la Bibliografia e i termini delle Licenze, se tali elementi sono immersi in 12 doc monolitici, bisogna realizzare ALMENO 3 modifiche in 12 documenti distinti, per un totale di 36 modifiche "fisiche" distinte.
Ora immaginiamo che questi 3 elementi informativi siano 3 elementi modulari, indipendenti, scorrelati dal contesto in cui dovranno essere collocati. E che siano memorizzati in un Data Base, dove questi contenuti possono "vivere" in quanto contenuti "puri", scorrelati da altri vincoli.
Se li concepiamo così, dobbiamo fare soltanto 3 modifiche, uno per ogni "blocco rettangolare"!
I contenuti aggiornati verranno poi "propagati" in qualche modo, che vedremo la prossima volta, nei 12 documenti che ci servono. Ma ora quello che importa sottolineare è che siamo passati da 36 modifiche "fisiche", a sole 3 modifiche, una per ogni blocco informativo.
Ora la prossima domanda è: se invece di 12 documenti dovessi aggiornare questi contenuti in 120 documenti diversi, quante modifche dovrei apportare? SEMPRE E SOLO 3!
Dove sta il trucco? In tre passaggi concettuali fondamentali:
Molti, ma almeno uno lo possiamo "vedere" subito, aiutandoci con la figura seguente:
La figura forse vi farà venire in mente il Lego, un gioco per bambini che noi ultra-quarantenni (sob!) ricordiamo bene. Ecco, direi che tutta questa roba ha molte idee in comune con il Lego e i suoi famosi mattoncini.
Se abbiamo un DB di contenuti indipendenti, li possiamo "riusare" in documenti diversi, ove in ogni documento i suddetti contenuti possono essere eventualmente "montati" anche in modi diversi, come si intuisce dalla figura, dove sono stilizzati 4 documenti diversi.
Al prossimo post, per vedere altri vantaggi di questo approccio.
Leggi questo articolo...
Per entrare nel vivo, immaginiamo un caso d'uso concreto.
Abbiamo un prodotto generico, che deve essere accompagnato da un set di documenti di vario tipo. Poniamo che il numero complessivo di documenti sia pari a 12.
In tutti questi documenti potrebbero esistere dei contenuti informativi condivisi. Ad esempio, il Glossario dei termini tecnici e degli acronimi. Oppure la Bibliografia. O magari la definizione delle Licenze di parti specifiche contenute nel prodotto ma realizzate da terze parti.
Per qualche motivo, tutte queste parti devono essere presenti in tutti i 12 documenti.
Nella figura seguente, identifichiamo il Glossario con il rettangolo rosso, la Bibliografia con quello giallo e le Licenze con quello verde:
Dovendo modificare il Glossario, la Bibliografia e i termini delle Licenze, se tali elementi sono immersi in 12 doc monolitici, bisogna realizzare ALMENO 3 modifiche in 12 documenti distinti, per un totale di 36 modifiche "fisiche" distinte.
Ora immaginiamo che questi 3 elementi informativi siano 3 elementi modulari, indipendenti, scorrelati dal contesto in cui dovranno essere collocati. E che siano memorizzati in un Data Base, dove questi contenuti possono "vivere" in quanto contenuti "puri", scorrelati da altri vincoli.
Se li concepiamo così, dobbiamo fare soltanto 3 modifiche, uno per ogni "blocco rettangolare"!
I contenuti aggiornati verranno poi "propagati" in qualche modo, che vedremo la prossima volta, nei 12 documenti che ci servono. Ma ora quello che importa sottolineare è che siamo passati da 36 modifiche "fisiche", a sole 3 modifiche, una per ogni blocco informativo.
Ora la prossima domanda è: se invece di 12 documenti dovessi aggiornare questi contenuti in 120 documenti diversi, quante modifche dovrei apportare? SEMPRE E SOLO 3!
Dove sta il trucco? In tre passaggi concettuali fondamentali:
- abbiamo estratto i moduli dal documento monolitico;
- li abbiamo messi in un DB centralizzato, per implementare una filosofia "single source";
- abbiamo "scorrelato" la modifica del generico modulo dalla sua collocazione all'interno di N documenti distinti.
Molti, ma almeno uno lo possiamo "vedere" subito, aiutandoci con la figura seguente:
La figura forse vi farà venire in mente il Lego, un gioco per bambini che noi ultra-quarantenni (sob!) ricordiamo bene. Ecco, direi che tutta questa roba ha molte idee in comune con il Lego e i suoi famosi mattoncini.
Se abbiamo un DB di contenuti indipendenti, li possiamo "riusare" in documenti diversi, ove in ogni documento i suddetti contenuti possono essere eventualmente "montati" anche in modi diversi, come si intuisce dalla figura, dove sono stilizzati 4 documenti diversi.
Al prossimo post, per vedere altri vantaggi di questo approccio.
Leggi questo articolo...
giovedì 21 febbraio 2013
Un post di Francesco Vignotto sulla Qualità dei contenuti per Google
Vi segnalo un articolo interessante scritto da Francesco Vignotto su un tema che mi è molto caro: la qualità dei contenuti, anzi la Qualità, con la Q maiuscola.
In questo post, Francesco inizia ad illustrare il modo in cui Google valuta il livello qualitativo di quello che pubblichiamo in rete non solo sulla base delle caratteristiche "oggettive" del famoso algoritmo Panda, ma anche sulla base di "percezioni soggettive" affidate ai "quality raters", operatore umani opportunamente addestrati e impiegati da Google a tale scopo.
Spesso, nel passato, si è cercato di fornire regole asettiche o modelli matematici per descrivere/misurare, alcuni possibili "attributi" della qualità di quello che scriviamo (un esempio per tutti: gli Indici di Leggibilità).
Ma raramente si tiene invece conto di parametri deduttivi, dell'inferenza che il lettore opera sui contenuti, della percezione dei medesimi.
Aldilà della struttura oggettiva dei contenuti e della loro caratterizzazione linguistica-grammaticale-formale, è interessante indagare il modo in cui li recepiamo anche attraverso altri filtri.
Francesco propone anche un corso on line di scrittura Web.
Se vi interessa l'argomento, date un occhio alla sua proposta.
Leggi questo articolo...
In questo post, Francesco inizia ad illustrare il modo in cui Google valuta il livello qualitativo di quello che pubblichiamo in rete non solo sulla base delle caratteristiche "oggettive" del famoso algoritmo Panda, ma anche sulla base di "percezioni soggettive" affidate ai "quality raters", operatore umani opportunamente addestrati e impiegati da Google a tale scopo.
Spesso, nel passato, si è cercato di fornire regole asettiche o modelli matematici per descrivere/misurare, alcuni possibili "attributi" della qualità di quello che scriviamo (un esempio per tutti: gli Indici di Leggibilità).
Ma raramente si tiene invece conto di parametri deduttivi, dell'inferenza che il lettore opera sui contenuti, della percezione dei medesimi.
Aldilà della struttura oggettiva dei contenuti e della loro caratterizzazione linguistica-grammaticale-formale, è interessante indagare il modo in cui li recepiamo anche attraverso altri filtri.
Francesco propone anche un corso on line di scrittura Web.
Se vi interessa l'argomento, date un occhio alla sua proposta.
Leggi questo articolo...
domenica 17 febbraio 2013
Come si forma un Comunicatore Tecnico: seconda parte... ossia "il bruco e la farfalla"
Prima di iniziare lo sviluppo di questo tema, dobbiamo risolvere un problema di base.
Cosa intendiamo per Comunicatore Tecnico? E' solo uno mero sinonimo di Scrittore Tecnico, tradotto dall'inglese Technical Writer? O è una figura evoluta rispetto al tradizionale TW?
E se è vera quest'ultima ipotesi, si diventa Com Tec se e solo se prima si è stati TW o ci potrebbero essere contaminazioni diagonali meno semplici da comprimere in questo schema troppo lineare?
In diverse occasioni ho espresso la mia opinione in merito, ma ora è proprio il casi di ribadirla e argomentarla meglio.
La definizione tradizionale indica nel Technical Writer colui che crive i testi dei manuali che accompagnano prodotti e apparecchiature di ogni genere. Il suo lavoro consiste nella realizzazione di diverse tipologie di documenti.
È una figura professionale potenzialmente molto trasversale, che opera a contatto con gli ingegneri e i tecnici dei reparti di sviluppo e produzione, ma può collaborare anche con gli uffici commerciali per la compilazione di bandi di gara o con l'area marketing per la realizzazione di un Case Study o di un White Paper.
Fino alla fine degli anni '80 del secolo scorso, questa definizone era perfetta e potevamo chiudere il post, senza avere null'altro da dire.
Ma poi è arrivata Internet, l'iper-testo, le interfacce grafiche, le animazioni 3D, i video, You Tube, i blog, i social networks. Gli studi sul cervello, la psico-neurologia e prima ancora la semiologia ci assicurano che la comunicazione verbale e scritta rappresentano solo una minima parte del modo in cui comunichiamo.
E poi sono arrivate nuove metodologie per l'organizzazione della informazioni e nuovi tool per la gestione integrata delle medesime. L'usabilità e l'ergonomia hanno influenzato il modo di progettare i prodotti e di decriverli. E poi altre cose ancora, che proverò a mettere in fila nei prossimi post, se pur brevemente.
Ed ecco che la definizione classica, così rassicurante, vacilla. Non basta più. Non copre tutti i fronti.
Se sto facendo un Video Tutorial che illustra la procedura per montare e configurare la centralina di controllo dell'impianto fotovoltaico, non sto "scrivendo" un manuale ma SICURAMENTE mi occupo di "comunicazione tecnica".
Se sto facendo una presentzione PPT che illustra i vantaggi di una certa soluzione, non sto scrivendo una scheda tecnica, ma qualcosa di molto più complesso ed è SICURAMENTE "comunicazione tecnica".
Il "bruco" Technical Writer non c'è più, se non nella tradizione e nella memoria di tecniche e metodologie di riferimento comunque sempre valide, oggi è il tempo della "farfalla" Comunicatore Tecnico, che ancora scrive documenti ma è chiamato ad occuparsi anche di altri paradigmi espressivi.
Nel 2005 ho iniziato da autodidatta questa professione e ricadevo perfettamente nella definizione di Technical Writer, poi mi sono accorto che evolvevo verso "altro" che è ANCHE e ANCORA scrittura ma NON SOLO scrittura.
A partire da questo punto, scopriremo che la figura del Com Tec racchiude profili professionali anche molto diversi e sarà più semplice provare a definire quanta e quale formazione necessita. Leggi questo articolo...
Cosa intendiamo per Comunicatore Tecnico? E' solo uno mero sinonimo di Scrittore Tecnico, tradotto dall'inglese Technical Writer? O è una figura evoluta rispetto al tradizionale TW?
E se è vera quest'ultima ipotesi, si diventa Com Tec se e solo se prima si è stati TW o ci potrebbero essere contaminazioni diagonali meno semplici da comprimere in questo schema troppo lineare?
In diverse occasioni ho espresso la mia opinione in merito, ma ora è proprio il casi di ribadirla e argomentarla meglio.
La definizione tradizionale indica nel Technical Writer colui che crive i testi dei manuali che accompagnano prodotti e apparecchiature di ogni genere. Il suo lavoro consiste nella realizzazione di diverse tipologie di documenti.
È una figura professionale potenzialmente molto trasversale, che opera a contatto con gli ingegneri e i tecnici dei reparti di sviluppo e produzione, ma può collaborare anche con gli uffici commerciali per la compilazione di bandi di gara o con l'area marketing per la realizzazione di un Case Study o di un White Paper.
Fino alla fine degli anni '80 del secolo scorso, questa definizone era perfetta e potevamo chiudere il post, senza avere null'altro da dire.
Ma poi è arrivata Internet, l'iper-testo, le interfacce grafiche, le animazioni 3D, i video, You Tube, i blog, i social networks. Gli studi sul cervello, la psico-neurologia e prima ancora la semiologia ci assicurano che la comunicazione verbale e scritta rappresentano solo una minima parte del modo in cui comunichiamo.
E poi sono arrivate nuove metodologie per l'organizzazione della informazioni e nuovi tool per la gestione integrata delle medesime. L'usabilità e l'ergonomia hanno influenzato il modo di progettare i prodotti e di decriverli. E poi altre cose ancora, che proverò a mettere in fila nei prossimi post, se pur brevemente.
Ed ecco che la definizione classica, così rassicurante, vacilla. Non basta più. Non copre tutti i fronti.
Se sto facendo un Video Tutorial che illustra la procedura per montare e configurare la centralina di controllo dell'impianto fotovoltaico, non sto "scrivendo" un manuale ma SICURAMENTE mi occupo di "comunicazione tecnica".
Se sto facendo una presentzione PPT che illustra i vantaggi di una certa soluzione, non sto scrivendo una scheda tecnica, ma qualcosa di molto più complesso ed è SICURAMENTE "comunicazione tecnica".
Il "bruco" Technical Writer non c'è più, se non nella tradizione e nella memoria di tecniche e metodologie di riferimento comunque sempre valide, oggi è il tempo della "farfalla" Comunicatore Tecnico, che ancora scrive documenti ma è chiamato ad occuparsi anche di altri paradigmi espressivi.
Nel 2005 ho iniziato da autodidatta questa professione e ricadevo perfettamente nella definizione di Technical Writer, poi mi sono accorto che evolvevo verso "altro" che è ANCHE e ANCORA scrittura ma NON SOLO scrittura.
A partire da questo punto, scopriremo che la figura del Com Tec racchiude profili professionali anche molto diversi e sarà più semplice provare a definire quanta e quale formazione necessita. Leggi questo articolo...
venerdì 8 febbraio 2013
Una bella occasione di formazione: IM e ASD-STE
Come vi ho indicato in un recente post, sto preparando del materiale sul tema della formazione di un Technical Communicator.
E quindi credo sia giusto prendere la palla al balzo e segnalarvi una delle pochissime iniziative di formazione di ottimo livello che potete trovare in Italia.
Dal 18 al 22 Febbraio, Writec e Shufra proporranno un programma completo di formazione, basato su due metodologie ben note, Information Mapping® e ASD-STE100, finalizzate a migliorare leggibilità e accessibilità dei vostri documenti.
Information Mapping® è un metodo basato per la redazione strutturata e modulare di documenti tecnici e di business, che offre gli strumenti per analizzare, organizzare e presentare le informazioni in modo chiaro, coerente e definito in base alle esigenze dei destinatari.
ASD-STE100 (Simplified Technical English) è uno standard internazionale relativo al linguaggio usato nei manuali tecnici. Il suo utilizzo migliora la leggibilità e la traducibilità della documentazione tecnica in ogni settore, favorendone l'efficacia e la qualità con notevoli risparmi sui costi per le pubblicazioni multilingue.
Il primo corso, della durata di 2 giorni, verrà condotto da Vilma Zamboli (Writec), di cui vi ho parlato in più di un'occasione, autentico punto di riferimento in Italia per tutti coloro che lavorano nel campo della scrittura tecnica.
Il secondo corso (anch'esso su 2 giorni), verrà condotto da Frans Wijma (Shufra), esperto riconosciuto in Simplified Technical English.
La formula è interessante, per diversi motivi:
Leggi questo articolo...
E quindi credo sia giusto prendere la palla al balzo e segnalarvi una delle pochissime iniziative di formazione di ottimo livello che potete trovare in Italia.
Dal 18 al 22 Febbraio, Writec e Shufra proporranno un programma completo di formazione, basato su due metodologie ben note, Information Mapping® e ASD-STE100, finalizzate a migliorare leggibilità e accessibilità dei vostri documenti.
Information Mapping® è un metodo basato per la redazione strutturata e modulare di documenti tecnici e di business, che offre gli strumenti per analizzare, organizzare e presentare le informazioni in modo chiaro, coerente e definito in base alle esigenze dei destinatari.
ASD-STE100 (Simplified Technical English) è uno standard internazionale relativo al linguaggio usato nei manuali tecnici. Il suo utilizzo migliora la leggibilità e la traducibilità della documentazione tecnica in ogni settore, favorendone l'efficacia e la qualità con notevoli risparmi sui costi per le pubblicazioni multilingue.
Il primo corso, della durata di 2 giorni, verrà condotto da Vilma Zamboli (Writec), di cui vi ho parlato in più di un'occasione, autentico punto di riferimento in Italia per tutti coloro che lavorano nel campo della scrittura tecnica.
Il secondo corso (anch'esso su 2 giorni), verrà condotto da Frans Wijma (Shufra), esperto riconosciuto in Simplified Technical English.
La formula è interessante, per diversi motivi:
- si può decidere di seguire entrambi i corsi (in tal caso poi si accede ad una Master Class nel 5° giorno) o solo uno dei due;
- viene proposta una sinergia tra 2 metodologie note, tra le più interessanti nel campo della comunicazione tecnica;
- almeno in Italia, è un'occasione di full-immersion decisamente rara, condotta peraltro da professionisti di livello.
Leggi questo articolo...
domenica 27 gennaio 2013
Dalla scrittura monolitica alla scrittura modulare: seconda parte
Esaminate la figura seguente:
Che cosa potrebbe essere questa collezione disordinata di numeri e parole? Quante volte, durante la giornata, vi capita di parlare di "dati"? E' un concetto che ormai usiamo spesso. Parliamo dei "dati di ascolto", dei "dati indicati dalle statistiche", dei "dati che emergono da un sondaggio" o dei "dati caricati in memoria". Parliamo di dati, ma raramente li visualizziamo così come mostrato nella figura precedente, come un insieme di informazioni numeriche e testuali PURE, non miscelate a nessun tipo di FORMA.
Ora osservate la figura successiva:
Cosa è cambiato? Gli stessi dati di prima sono collocati in una tabella, cioè in una particolare FORMA.
I dati della figura precedente non mostravano alcun significato evidente, ora il loro significato ci appare chiaro. Quali conclusioni possiamo trarre da questo semplice esperimento?
I DATI PURI, scorrelati da un contesto e da una FORMA, non hanno alcun significato o, più prudentemente, direi che il loro significato è difficilmente individuabile.
La FORMA in cui essi sono collocati fa emergere la loro SEMANTICA.
Ma ora immaginiamo, con gli stessi dati, di realizzare un grafico ad istogrammi, cioè una forma ben diversa dalla tabella precedente. Se dovete visualizzare i dati in una presentazione, il grafico ad istogrammi sarà di più facile comprensione rispetto ad una tabella; la tabella magari sarà più adatta ad un manuale tradizionale.
E magari potremmo immaginare una terza forma, in cui collocarli.
Cambierebbe la loro SEMANTICA? No, ma non è questo il punto.
Le conclusioni che possiamo trarre da questi esempi sono almeno due:
- non possiamo capire il significato dei dati, se non li collochiamo DENTRO UNA FORMA
- sarebbe bello disporre di dati PURI, non miscelati con alcuna FORMA, in modo da poterli poi collocare, di volta in volta, in "forme diverse" in base all'utilità che vogliamo perseguire.
Questo è un concetto chiave: se è possibile tenere separati FORMA e CONTENUTO, allora possiamo immaginare di non dover scrivere un documento direttamente in formato Word o PDF, ma possiamo concepire l'idea che i dati di un documento (testi, immagini, ...) possano esistere, in qualche modo, distinti e scorrelati da qualsiasi forma, per poi essere "collocati", di volta in volta, nella forma che desideriamo.
Riprendendo il post introduttivo, potremmo dire che scrivere un manuale usando direttamente Word significa "fare la frittata", mentre ora stiamo iniziando a considerare la possibilità di tenere separati "il tuorlo" e "l'albume", cioè i CONTENUTI e la FORMA.
Questo è il primo passo per iniziare a pensare in termini di "scrittura modulare".
Leggi questo articolo...
Che cosa potrebbe essere questa collezione disordinata di numeri e parole? Quante volte, durante la giornata, vi capita di parlare di "dati"? E' un concetto che ormai usiamo spesso. Parliamo dei "dati di ascolto", dei "dati indicati dalle statistiche", dei "dati che emergono da un sondaggio" o dei "dati caricati in memoria". Parliamo di dati, ma raramente li visualizziamo così come mostrato nella figura precedente, come un insieme di informazioni numeriche e testuali PURE, non miscelate a nessun tipo di FORMA.
Ora osservate la figura successiva:
Cosa è cambiato? Gli stessi dati di prima sono collocati in una tabella, cioè in una particolare FORMA.
I dati della figura precedente non mostravano alcun significato evidente, ora il loro significato ci appare chiaro. Quali conclusioni possiamo trarre da questo semplice esperimento?
I DATI PURI, scorrelati da un contesto e da una FORMA, non hanno alcun significato o, più prudentemente, direi che il loro significato è difficilmente individuabile.
La FORMA in cui essi sono collocati fa emergere la loro SEMANTICA.
Ma ora immaginiamo, con gli stessi dati, di realizzare un grafico ad istogrammi, cioè una forma ben diversa dalla tabella precedente. Se dovete visualizzare i dati in una presentazione, il grafico ad istogrammi sarà di più facile comprensione rispetto ad una tabella; la tabella magari sarà più adatta ad un manuale tradizionale.
E magari potremmo immaginare una terza forma, in cui collocarli.
Cambierebbe la loro SEMANTICA? No, ma non è questo il punto.
Le conclusioni che possiamo trarre da questi esempi sono almeno due:
- non possiamo capire il significato dei dati, se non li collochiamo DENTRO UNA FORMA
- sarebbe bello disporre di dati PURI, non miscelati con alcuna FORMA, in modo da poterli poi collocare, di volta in volta, in "forme diverse" in base all'utilità che vogliamo perseguire.
Questo è un concetto chiave: se è possibile tenere separati FORMA e CONTENUTO, allora possiamo immaginare di non dover scrivere un documento direttamente in formato Word o PDF, ma possiamo concepire l'idea che i dati di un documento (testi, immagini, ...) possano esistere, in qualche modo, distinti e scorrelati da qualsiasi forma, per poi essere "collocati", di volta in volta, nella forma che desideriamo.
Riprendendo il post introduttivo, potremmo dire che scrivere un manuale usando direttamente Word significa "fare la frittata", mentre ora stiamo iniziando a considerare la possibilità di tenere separati "il tuorlo" e "l'albume", cioè i CONTENUTI e la FORMA.
Questo è il primo passo per iniziare a pensare in termini di "scrittura modulare".
Leggi questo articolo...
sabato 26 gennaio 2013
Come si forma un Comunicatore Tecnico: prima parte
Chi segue questo blog dal 2009, conosce la mia storia professionale. I lettori più recenti possono andare a rileggere i post dei primi mesi del 2009, per avere un'idea di come ho iniziato.
Li ho riletti anche io questa mattina, arrivando alla curiosa conclusione che anche per me è abbastanza difficile stabilire se sia stato io a scegliere effettivamente questa professione o se, in qualche modo, sia stata lei a scegliere me!
La verità, come sempre, sta probabilmente in un mix di queste due cose.
Ho sempre dichiarato di essere un auto-didatta della Comunicazione Tecnica.
Mi sono formato con intensità, nel più classico paradigma del "training on the job" e del più pragmatico e anglosassone "practice makes perfect", misurandomi ogni giorno con i problemi concreti che dovevo risolvere per l'azienda in cui lavoro da ormai 11 anni.
Ogni giorno decisioni rapide, concrete, che generavano risultati tangibili. Magari alcune completamente sbagliate; e allora si impara dall'errore e si migliora progressivamente. E di notte a studiare sul Web e sui libri, per capire cosa avevano ideato gli altri, per imparare a copiare i modelli migliori e scartare quelli inadatti alla mia realtà.
E via via, scoprivo dei "buchi" nella mia preparazione e cercavo di colmarli, a volte efficacemente, a volte meno, ma piuttosto che niente è sempre meglio "piuttosto".
Il tutto, togliendo del tempo al sonno notturno e ai miei week-end, spinto da un'energia "barbarica" che, fortunatamente, ancora mi sorregge.
Ma questo modello formativo, che ha funzionato per me, può essere un modello da proporre ad altri?
Esiste un altro modo per pensare di avvicinarsi a questa professione?
Quale spettro di conoscenze bisogna acquisire per poter fare questo lavoro?
E come ed in quanto tempo si possono acquisire?
Questo è il primo post di una serie in cui cercherò di darvi il mio punto di vista su queste ed altre domande, tutte inerenti al tema della formazione e del "...come faccio a diventare un Comunicatore Tecnico?".
Questa è una delle domande più frequenti che mi viene rivolta e ne ho avuto riscontro anche nell'ambito dei 3 Webinar che ho condotto tra Settembre ed Ottobre del 2012.
Con questo ciclo di articoli spero di dare un contributo, anche solo parziale, per definire una possibile risposta.
A presto.
Leggi questo articolo...
domenica 20 gennaio 2013
Dalla scrittura monolitica alla scrittura modulare: prima parte
Se vi state accingendo a realizzare un manuale, è probabile che abbiate già iniziato a progettare un indice. Sorvolo su quanto sia frustrante iniziare a scrivere un manuale iniziando dall'elemento che, durante lo sviluppo del documento, dovrete probabilmente ri-organizzare almeno una decina di volte. Ma a scuola ci hanno insegnato che "prima di tutto, bisogna definire un indice dei contenuti" e voi così fate.
Poco importa se a scuola ci hanno insegnato una stupidaggine, lo capiremo strada facendo.
Un indice è composto da una sequenza di capitoli; ogni capitolo, da una sequenza di paragrafi di primo livello e ogni paragrafo di primo livello da una serie di sotto-paragrafi di secondo livelllo e così via.
Nei manuali della mia azienda, ad esempio, adottiamo fino a 5 livelli di titolazione:
Per il solo fatto di aver fatto questa prima operazione, avete già definito un ordine ben definito di esposizione dei contenuti, dove tra 2 contenuti distinti esiste già, prima ancora che i contenuti prendano forma, "un PRIMA" e "un DOPO", quindi un legame ORDINALE, che sussiste prima ancora di aver definito la loro natura.
Ma è molto probabile che stiate facendo tutto ciò usando un "word processor", cioè di un software dedicato alla redazione di testi.
Magari questo software è Word di Microsoft Office, oppure il Writer di Open Office.
Non è fondamentale lo strumento che avete scelto, quel che importa è che mentre strutturate l'indice, state già facendo scelte formali: che tipo di font utilizzare per i 5 livelli di titolazione, il relativo font size (la dimensione dei caratteri dei diversi titoli). Poi deciderete il font per il testo (Verdana? Arial? Calibri?), poi il formato delle tabelle, poi il formato delle note e via così.
In altri termini, prima di definire i contenuti, state decidendo LA FORMA che assumeranno. Se vogliamo essere più precisi, i vosti contenuti prenderanno vita già "all'interno" di una forma, "miscelati" con essa.
Inoltre, state già definendo IL TIPO DI FORMATO del documento, ad esempio .doc se usate Office Word.
Sorprendente vero? Non avete scritto nulla, non avete definito alcun contenuto e avete già preso moltissime decisioni che guideranno il vostro lavoro fin dall'inizio.
Se state lavorando così, state realizzando un documento MONOLITICO, secondo un approccio valido ma tradizionale, in cui i contenuti nascono già con dei vincoli ORDINALI e FORMALI, dove sostanza e forma sono già miscelati insieme, come il tuorlo e l'albume di un uovo quando fate una frittata (l'immagine è perfetta ma non è mia, la prendo in prestito da una felice intuizione di Marco Galiazzo).
Dopo aver fatto una frittata, siete mai riuscti a ri-separare di nuovo il tuorlo e l'albume? La domanda è retorica, la risposta è ovviamente no, non è possibile.
Nel caso di un documento Word, teoricamente, è comunque possibile recuperare i contenuti e "ripulirli" dalla forma in cui sono immersi, ma è un lavoro molto lento e noioso.
Se quegli stessi contenuti che avete "miscelato" in un file .doc, ora vi necessitano in formato HTML, come si fa? E non mi rispondete che basta salvare il file in formato .html, la delusione mi ucciderebbe!
C'è un modo diverso di fare le cose?
Si. Ma bisogna fare più di un salto concettuale per poter mettere in discussione l'approccio tradizionale che vi ho appena descritto, al quale siamo stati educati da tanti anni di pratica.
A partire dal prossimo post, vedremo che può essere molto utile tenere ben distinti FORMA e CONTENUTO e da lì partiremo per approfondire diverse questioni.
Leggi questo articolo...
Poco importa se a scuola ci hanno insegnato una stupidaggine, lo capiremo strada facendo.
Un indice è composto da una sequenza di capitoli; ogni capitolo, da una sequenza di paragrafi di primo livello e ogni paragrafo di primo livello da una serie di sotto-paragrafi di secondo livelllo e così via.
Nei manuali della mia azienda, ad esempio, adottiamo fino a 5 livelli di titolazione:
Per il solo fatto di aver fatto questa prima operazione, avete già definito un ordine ben definito di esposizione dei contenuti, dove tra 2 contenuti distinti esiste già, prima ancora che i contenuti prendano forma, "un PRIMA" e "un DOPO", quindi un legame ORDINALE, che sussiste prima ancora di aver definito la loro natura.
Ma è molto probabile che stiate facendo tutto ciò usando un "word processor", cioè di un software dedicato alla redazione di testi.
Magari questo software è Word di Microsoft Office, oppure il Writer di Open Office.
Non è fondamentale lo strumento che avete scelto, quel che importa è che mentre strutturate l'indice, state già facendo scelte formali: che tipo di font utilizzare per i 5 livelli di titolazione, il relativo font size (la dimensione dei caratteri dei diversi titoli). Poi deciderete il font per il testo (Verdana? Arial? Calibri?), poi il formato delle tabelle, poi il formato delle note e via così.
In altri termini, prima di definire i contenuti, state decidendo LA FORMA che assumeranno. Se vogliamo essere più precisi, i vosti contenuti prenderanno vita già "all'interno" di una forma, "miscelati" con essa.
Inoltre, state già definendo IL TIPO DI FORMATO del documento, ad esempio .doc se usate Office Word.
Sorprendente vero? Non avete scritto nulla, non avete definito alcun contenuto e avete già preso moltissime decisioni che guideranno il vostro lavoro fin dall'inizio.
Se state lavorando così, state realizzando un documento MONOLITICO, secondo un approccio valido ma tradizionale, in cui i contenuti nascono già con dei vincoli ORDINALI e FORMALI, dove sostanza e forma sono già miscelati insieme, come il tuorlo e l'albume di un uovo quando fate una frittata (l'immagine è perfetta ma non è mia, la prendo in prestito da una felice intuizione di Marco Galiazzo).
Dopo aver fatto una frittata, siete mai riuscti a ri-separare di nuovo il tuorlo e l'albume? La domanda è retorica, la risposta è ovviamente no, non è possibile.
Nel caso di un documento Word, teoricamente, è comunque possibile recuperare i contenuti e "ripulirli" dalla forma in cui sono immersi, ma è un lavoro molto lento e noioso.
Se quegli stessi contenuti che avete "miscelato" in un file .doc, ora vi necessitano in formato HTML, come si fa? E non mi rispondete che basta salvare il file in formato .html, la delusione mi ucciderebbe!
C'è un modo diverso di fare le cose?
Si. Ma bisogna fare più di un salto concettuale per poter mettere in discussione l'approccio tradizionale che vi ho appena descritto, al quale siamo stati educati da tanti anni di pratica.
A partire dal prossimo post, vedremo che può essere molto utile tenere ben distinti FORMA e CONTENUTO e da lì partiremo per approfondire diverse questioni.
Leggi questo articolo...
domenica 13 gennaio 2013
Il Foglietto Illustrativo dei medicinali
Il foglietto illustrativo è il più diffuso documento tecnico in ambito farmaceutico.
E’ contenuto – per legge – in ogni farmaco, a esclusione dei farmaci omeopatici e fitoterapici (integratori) ed è quindi un documento ufficiale. Oltre a questo, il foglietto illustrativo dovrebbe essere anche uno strumento comunicativo efficace perché riguarda l’impiego di prodotti riguardanti la salute, ossia un ambito delicato e difficile.
Purtroppo, non è sempre così. Soprattutto in Italia, il foglietto illustrativo (ancora oggi spesso chiamato “bugiardino”) è innanzitutto un documento redatto in base a precisi vincoli normativi e burocratici.
Ma questo approccio spesso si rivela disarmonico con l’idea che debba essere anche un mezzo di comunicazione efficace al corretto uso del farmaco, quindi con un’attenzione più focalizzata sulla capacità di comprensione dei contenuti da parte dell’utente che lo deve assumere.
In anni recenti, la European Medicines Agency (EMA) ha modificato il format dei foglietti illustrativi dei nuovi farmaci approvati a livello europeo.
Quindi oggi possiamo avere foglietti con lo schema europeo, formulato con criteri di leggibilità ben precisi e/o strutturato con “domande e risposte”, ma anche foglietti illustrativi di farmaci approvati e immessi in commercio da tempo, redatti con lo schema tradizionale, generalmente approvati solo per il territorio nazionale.
Oltre alle informazioni standard richieste dalle autorità regolatorie, le case farmaceutiche possono aggiungere tutte le indicazioni che ritengono più opportune (inserite, comunque, nell’elenco delle caratteristiche per cui il prodotto è stato approvato).
Di conseguenza, i farmaci con lo stesso principio attivo ma prodotti da società diverse possono avere foglietti illustrativi con testi differenti e, a volte, con discrepanze di vario genere.
Dal punto di vista dei contenuti le informazioni sono numerose, a volte troppo “affollate” e, soprattutto, poco comprensibili.
Da alcuni sondaggi condotti sul pubblico, i principali ostacoli alla comprensione del foglietto illustrativo sono:
- eccessiva lunghezza
- linguaggio troppo tecnico
- carattere di stampa troppo piccolo
- mancanza di risalto delle principali avvertenze
- scarsa chiarezza sui rischi ed effetti indesiderati
- “interazione tra farmaci” è un'indicazione che risulta, di fatto, incomprensibile
- “posologia” potrebbe essere sostituito con “modalità di somministrazione”
- “evitare l’uso prolungato” è un concetto poco chiaro... prolungato quanto?
Iscriviti a:
Post (Atom)
