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...
mercoledì 27 febbraio 2013
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...
Categoria:
Il mestiere del TW
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...
Categoria:
Saper scrivere
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...
Categoria:
Formazione
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...
Categoria:
Formazione
Iscriviti a:
Post (Atom)