domenica 28 giugno 2026

Come uso l'AI: la raccolta delle informazioni e il controllo di qualità - 1

L'ultimo articolo sull'argomento "come uso l'AI" lo avevo scritto il 23 Febbraio e nel frattempo ho condotto un'intensa attività di sperimentazione.

E siccome sono una persona intellettualmente onesta, oggi sono in grado di mettere in discussione alcune delle affermazioni che avevo fatto.

Ma andiamo con ordine, perchè le cose da dire sono tante.

Per prima cosa, partiamo da un principio generale: l'AI non è magia, se gli dai in pasto spazzatura ti restituirà spazzatura amplificata e se non sai fare le domande giuste non puoi pretendere di avere le risposte giuste.

Questo è il primo motivo per il quale l'AI non può sostituire un umano che sa come utilizzarla.

Quindi la prima domanda che devi farti è: in quale parte del mio processo lavorativo posso integrare l'AI in modo UTILE?

Eh si... perchè dopo 3 anni di hype ora anche i fuffa-guru alzano bandiera bianca e ammettono che l'AI non entrerà ovunque, in qualsiasi processo lavorativo, in qualsiasi contesto, a tutti i livelli, e non arriveranno la cavallette e non pioverà fuoco dal cielo se non adotterai l'AI.

Più pragmaticamnte, devi valutare SE e DOVE l'AI può portarti dei vantaggi, quanto ti costa acquisire questo vantaggio (la "Token ansiety" ha travolto anche aziende molto strutturate), quale può essere il ROI (Return of Investment) EFFETTIVO.

Perchè "a chiacchiere e gazzosa" siamo tutti esperti ma poi quando i conti non tornano il risveglio può essere brusco.

Ed è esattamente quello che ho fatto io. E ora ve lo racconto.

IL MIO PROCESSO LAVORATIVO



Volendo semplificare all'osso, il mio processo lavorativo può essere schematizzato secondo un diagramma in 5 fasi

In realtà, è un molto più complesso, ma per i nostri scopi questo schema è sufficiente.

PLANNING 

Deriva dalle attività d'ingegneria del software condotte nella società in cui lavoro. Rispetto a tali attività vengono fissate priorità, tempi di realizzazione, scadenze di produzione. Ed io devo adeguare concordemente la pianificazione della necessaria documentazione di prodotto.

DATA COLLECTION

E' una delle attività più critiche. Tradizionalmente, si affrontava questa fase attraverso delle interviste semi-strutturate con i Subject Matter Experts (SMEs). Al risultato delle interviste si aggiungevano le bozze disponibili di qualsiasi tipo di documento, sviluppato da chiunque in azienda, o le evidenze rintracciabili nel Data Base, o da qualsiasi altra sorgente. 

Alla fine tutte le informazioni confluivano in una prima bozza che veniva sottoposta agli SMEs per una prima verifica.

Il processo iterava dalle 2 alle 4 volte (anche in base alla complessità del topic) e consumava non solo il tempo del Tech Writer ma anche quello degli SMEs.

Questa fase mi è apparsa fin da subito molto adatta per assorbire un processo di analisi basato sull'AI.

In particolare, lavorando per una società che sviluppa software, mi è sembrato opportuno provare ad estrarre i dati che mi servivano DIRETTAMENTE dal codice: quindi non più dal racconto degli SMEs ma direttamente dal codice che viene reralizzato dagli SMEs.

In un articolo scritto il 6 Febbraio elencavo una serie di cose che l'AI NON POTEVA FARE.

Negli esperimenti che ho fatto sulla raccolta dei dati direttamente a partire dal codice, mi sono reso conto che questa affermazione va in parte corretta: alcune cose LE PUO' FARE, poi rimane in discussione la qualità del risultato e su questo farò degli esempi precisi nel prossimo articolo. Ma il miglioramento dei modelli negli ultimi 4 mesi ha reso possibile cose che all'inizio dell'anno presentavano una qualità non accettabile. Ora invece si può ottenere qualcosa di utile.

Dove sta il nucleo del mio obiettivo? Quello che ottenevo in 5 o 6 giorni di analisi di documenti grezzi e conversazioni con gli esperti del topic era una prima bozza che andava comunque verificata prima di andare oltre. Ora le informazioni le ottengo in meno di 10 minuti e la prima bozza la chiudo in una giornata.

E' SEMPRE UNA BOZZA da verificare, ma ho risparmiato 4 o 5 giorni. Ma non ho risparmiato solo IL MIO TEMPO ma anche quello degli SMEs.

WRITING

Con buona pace dei fuffa-guru, questa è ancora un'attività umana. In questo articolo non entro nei dettagli, sarebbe una lunga conversazione. Se siete interessati, contattatemi in privato. E' chiaro che io non pubblico quello che mi restituisce l'AI senza verificarlo, magari riorganizzando la struttura delle informazioni secondo i criteri che ritengo opportuni, verificando la concordanaza della terminologia rispetto alla documentazione già pubblicata, etc. 

Se volete far scrivere e pubblicare la documentazione di prodotto IN AUTOMATICO dalla AI, tanti auguri: non sono il vostro uomo.

REVIEW & QUALITY CHECKS

Questo è stato il primo campo da gioco in cui ho sperimentato, come accennavo il 23 Febbraio.

Ad oggi dispongo di un framework flessibile e configurabile che mi consente di valutare la qualità di QUALSIASI TIPO di contenuto: da un singolo documento (in qualsiasi formato ispezionabile), ad un Online Help o una Knowledge Base.

Sono in grado di esprimere un indice di qualità per ogni singolo criterio utilizzato (N criteri liberamente configurabili) e un indice di qualità composito che tiene conto dei livelli di qualità dei singoli criteri.

Ecco un esempio di un particolare criterio:


Per ogni criterio si produce un report che evidenzia il risultato, la severità associata alla situazione, una proposta per migliorare il livello di qualità e l'evidenza del file (il report può elencare anche TUTTI i file coinvolti, per la leggibilità di questo esempio ho indicato un file fittizio), nonchè il livello di qualità registrato (in questo caso 82 su 100).

Come vedete da questo esempio, si potrebbe demandare all'AI la messa in atto della soluzione proposta: "Split long sentences and normalize punctuation for US English".

Quindi ripetere il check e vedere se l'indice di qualità è migliorato.

Questo può andar bene se parliamo di una issue di severità minor, che si limita a migliorare la punteggiatura e spezzare le frasi troppo lunghe.

Ma io preferisco ancora procedere con una verifica personale.

Il vantaggio di questo framework è che posso analizzare 500-600 pagine di documentazione verificando in parallelo N criteri e ottengo il risultato in pochi minuti. Questo non mi esime dalla fatica delle verifica e della riscrittura, ma mi guida nell'intervenire prima su quelle aree dove l'indice di qualità è basso.

Ma questo framework è così potente, nella sua semplicità, che potrebbe essere utlizzato per capire, ad esempio, se la documentazione di prodotto di una macchina industriale rispetta le regole del nuovo Regolamento Macchine.

"Hey aspetta un attimo... tu sei un espertro di documentazione del software... che ne sai di Regolamento Macchine?"

Non c'è trucco e non c'è inganno: tutto dipende dal contesto di dominio che si fornisce all'AI e dalla conoscenza di dominio di colui che formula i criteri da verificare.

Questo è il secondo motivo per cui l'AI non può sostituire un umano: la conoscenza di dominio che serve sia a configurare il framework, sia a verificare le risposte fornite dall'AI.

E TUTTO QUESTO QUANTO MI COSTA?

E questa è un'altra conversazione. In questi ultimi mesi sono arrivate agli onori della cronaca decine di aziende che hanno bruciato in 3 mesi il budget di token di un anno. Su questo argomento non ho ricette. Ogni azienda deve fare le sue valutazioni. E deve capire dove sta il ROI. Io ho ottenuto tutto questo senza bruciare il denaro dell'azienda, perchè sapevo esattamente cosa volevo ottenere e sono stato in grado di scrivere un set di file markdown che imponevano all'AI paletti molto precisi. Non ho avuto bisogno di fare vibe coding, non ho dovuto fare 200 iterazioni "a caso", perchè sapevo tutto PRIMA. Ma tutto questo forse funziona solo per me e per il mio use case. Non saprei dire.

Peraltro, sto ancora limando e sperimentando. 

Ma già ora lo stumento è abbastanza buono e veloce.

"E le allucinazioni?"

Quelle ci sono e ci saranno sempre. Quanto più disegni delle regole ben fatte e precise, tanto più puoi sperare che le allucinazioni diminuiscano, mai che possano essere eliminate.

Anche per questo la verifica FINALE prima della pubblicazione DEVE ESSERE DI UN UMANO.

PUBLISHING

E' la fase finale del mio lavoro. Per tutto quanto già detto, e per altri motivi tecnici che non sto qui ad illustrare, qui l'AI non entra, anche perchè comunque il livello di automazione dei processi di publishing è già molto elevato, efficace e testato. 

Ecco un bell'esempio di dove si può fare a meno dell'AI. 

Perchè sprecare token quando si dispone di processi già standardizzati, deterministici, automatici, testati da molti anni e affidabili?

Per il resto, al prossimo articolo.

Leggi questo articolo...

lunedì 23 febbraio 2026

Come uso l'AI: il controllo di qualità

Quando lavoravo in IBM, nel mio IDE (Integrated Development Environment) era installato il plug-in di una famosa società tedesca (di cui non farò il nome).

Questo strumento mi aiutava a scrivere documentazione che fosse conforme a 3 standard contemporaneamente:

Mentre scrivevo, in tempo reale lo strumento mi indicava gli eventuali errori che facevo aiutandomi nel correggerli.

Avete mai provato a consultare 3 manuali diversi della IBM? Vi sembreranno scritti dalla stessa mano. Ovviamente non è così, ma quello strumento offriva a tutti i technical writer della IBM la possibilità di scrivere contenuti perfettamente conformi agli standard sopra indicati.

Oggi non dispongo di un IDE così configurato ma da un pò di tempo sto sperimentando un prompt che mi aiuta a realizzare un controllo di qualità "a posteriori".

L'azienda in cui lavoro mi mette a disposizone un AI engine (che non nominerò ma che indicherò con AI name) e io cerco di sfruttarlo.

INCISO: Per tutti gli smanettoni che leggendo il mio post mi suggeriranno "Ma perchè non usi lo strumento A... e non provi l'agente B...", preciso che io posso usare solo strumenti autorizzati dall'azienda. Perchè la conformità legale e la sicurezza vengono prima di qualsiasi considerazione tecnica.

Tenete presente che io scrivo documentazione tecnica DIRETTAMENTE in lingua Inglese dal 2008.
Ovviamente il mio Inglese nel 2008 era... diciamo così... grezzo... e sono indulgente con me stesso.
Oggi è molto migliorato, ma posso commettere ancora errori, perchè non sono un English native speaker.

Per questo, mi affidavo ad una bravissima collega (ciao Danila!) che mi affiancava ed era preziosa nel migliorare la qualità della documentazione aziendale... perchè 4 occhi vedono meglio di 2 e perchè era veramente in gamba.

Ora che non lavora più con me, devo comunque assicurare un livello adeguato di qualità dei nostri contenuti.

Per questo motivo, da alcune settimane sto sperimentando un prompt, che sto progressivamente affinando. Vediamo la sua struttura generale. 

IL PROMPT
Ci sono N sezioni specifiche, più  una FINAL SECTION.


SCOPE
You must act as an expert editor. You must implement a set of specific checks to improve the linguistic level of the content and the compliance with some rules of style.

ORTOGRAPHIC CORRECTNESS (US English-based)
Main attributes to analyze and check:
  • Spelling of words according to US English.
  • Typos and terminology inconsistencies
  • ... other specification...
  • ... other specification...
GRAMMATICAL CORRECTNESS
Main attributes to analyze and check:
  • Sentence structure
  • Articles, prepositions, verb tenses
  • ... other specifications...
  • ... other specifications...
REGISTER&NEUTRALITY
Main attributes to analyze and check:
  • Neutral and technical register
  • ... other specifications...
  • ... other specifications...
MICROSOFT STYLE GUIDE compliance
Main attributes to analyze and check:
  • General check about Microsoft Style Guide rules. A particular check about:
    • Active voice
    • ... other specifications...
    • ... other specifications...
COMPANY GLOSSARY compliance
Main attributes to analyze and check:
  • Verify that contents are coherent with company glossary.
  • If the text contains a term that may be synonymous with a term in the company glossary, report the occurrence and suggest replacing it with the glossary term.
  • ... other specifications...
  • ... other specifications...
SECTION ... K...
Main attributes to analyze and check:
  • ... other specifications...
  • ... other specifications...
SECTION ... K+1...
Main attributes to analyze and check:
  • ... other specifications...
  • ... other specifications...
SECTION ... N...
Main attributes to analyze and check:
  • ... other specifications...
  • ... other specifications...
FINAL SECTION
In this section is specified a set of rules that you (AI name) MUST COMPLY WITH . These rules are like "guard-rails" to limit your normal and structural inclination to hallucinate.

Rule 1: Don't ignore the instructions specified in the previous N sections.
Rule 2: Don't modify the source document but provide me a report with your proposal
Rule 3: I want a report for every specific section
Rule 4: The format of the report is: ... blablabla...
Rule 4: ...blablabla...
Rule 5: ...blablabla...
...
Rule N: You cannot ignore any of the previous rules.

----

Come vedete, non vi ho spifferato tutte le specifiche di ogni sezione (solo le principali) ma non perchè dovessi custodire chissà quali segreti. Semplicemente, perchè quel che conta è la struttura. Poi ognuno la può configurare come meglio crede per i propri bisogni.

IL PROCESSO
Quando devo avviare il controllo di qualità, io fornisco alla AI name:
  • Il prompt
  • Il documento da verificare
Dopo pochi secondi ottengo N report, uno per ogni sezione.
Ovviamente potrei ottenere un unico report onnicomprensivo, ma visto che voglio procedere per raffinamenti successivi, voglio verificare in che modo AI name opera in ogni sezione.

RISULTATI
Come stanno andando le cose? In generale, Danila era più brava.
Aveva una conoscenza completa del contesto e quando decideva di fare una modifica aveva sufficiente competenza per farla in autonomia, a meno di casi dubbi in cui si consultava con me.
Danila era intelligente (veramente) quindi non ragionava a "sezioni": il suo cervello e la sua preparazione professionale le consentivano di operare più controlli in parallelo, in modo fluido, senza il bisogno di definire una sequenza particolare, con attributi specifici.
Danila non aveva bisogno di essere istruita sul tono e sul registro, sul fatto di scrivere testi in active voice, sul fatto che il testo doveva essere conforme allo US English, perchè era una professionista esperta.

Ovviamente, AI name non è intelligente... ma è più veloce.
Lavorando per raffinamenti successivi, sto ottenenedo risultati sempre più affidabili.
Nonostante la sezione delle regole, ogni tanto aggiunge cose che non sono desumibili dal testo.
Bisogna controllare sezione per sezione, non si può assorbire il suo output in maniera automatica.
A volte suggerisce forme idiomatiche più eleganti del mio Inglese tecnico.
Ottimo. Ma a volte "si allarga" indebitamente.

Una volta, ha preso una procedura di N passi, dove in ogni passo io specifico UNA ed UNA SOLA AZIONE, attraverso l'uso di UNO ed UN SOLO VERBO. Evidentememte era una procedura spiegata troppo bene, ma un poco lunga e AI name ha provato a sintetizzare in un solo passo 2 o 3 passi distinti.
Lo ha fatto un paio di volte. Sbagliando. Perchè il modo giusto era il mio. Punto. Discorso chiuso.

In quel caso, non ho accettato il suggerimento. 
Ma ho inserito una specifica ulteriore sulle procedure step-by-step.

COME MIGLIORARE IL PROCESSO
Ci sono diversi passaggi. Cito solo i principali.

Automatizzare l'accesso alle pagine di contenuti
Ad oggi, il mio repository di contenuti non è accessibile per la AI name.
Io devo manualmente selezionare il contenuto che devo analizzare e darglielo in pasto.
Questo passo di automazione richiede lavoro extra, che va pianificato.

Iterare sulla struttura del prompt, per migliorare quello che va migliorato.
L'esempio che vi ho fatto sulla procedura step-by-step è emblematico: non basta lamentarsi del fatto che AI name sbaglia, ma bisogna costruire le giuste istruzioni per costringerla (entro certi limiti...) a non sbagliare. Questo si fa con un prompt che ha una struttura modulare, dove in ogni modulo (sezione) posso aggiungere specifiche iterativamente.

Definire un agent che sia in grado di modificare i contenuti in autonomia, dopo il mio nulla osta.
Questo è lo step più complesso.
Intanto va risolto il primo punto, cioè l'accesso al repository dei contenuti.
Che deve essere gestito in modo "sicuro", tanto più se si tratta di accedere in scrittura.

Poi ci sono tutta una serie di vincoli.

Ad esempio, quando scrivo un testo che verrà pubblicato nella documentazione aziendale, utilizzo un CSS (Cascading Style Sheet).
Attraverso di esso, contenuti "tipologicamente diversi" vengono "renderizzati" con stili diversi. Tali stili sono specificati nel CSS. Quindi l'agent dovrebbe accedere al CSS e avere la capacità di "riconoscere" lo stile del testo da modificare per mantenere lo stesso stile nel testo modificato. Non impossible, ma nemmeno banale.

Come ho spiegato in precedenza, la AI name non si accorge se cambia una GUI ma anche se se ne accorgesse, non riuscirebbe ad associare quel cambiamento ad un cambiamento della logica di business che quella GUI implementa. 

Per esempio, se ad una GUI viene aggiunto un pulsante DELETE, anche se AI name si accorgesse della variazione, non potrebbe sapere a QUALI OGGETTI o PROCESSI si potrebbe applicare l'azione di cancellazione, fra tutti quelli accessibil nella GUI.

Quindi:
  1. La logica che coinvolge il nuovo pulsante DELETE la devo scrivere io.
  2. Devo accertarmi di aggiornare anche lo screenshot eventualmente presente.
Altrimenti AI name validerebbe un testo (step 1) associato al vecchio screenshot, il che risulterebbe poco comprensibile per il lettore.

Come vedete, non è semplice creare un agent capace di riversare in autonomia le modifiche indicate nei report; in alcuni casi, non è possibile. Talvolta, non è nemmeno desiderabile. E comunque, io non rinuncio al mio potere di controllo. Perchè mi fido di me.

Alla prossima, con un nuovo capitolo su "Come uso l'AI".
Auspico il dibattito. Fatevi avanti!
Leggi questo articolo...

martedì 3 settembre 2019

Un brevetto per la sincronizzazione dei contenuti

Da qualche tempo è disponibile su Google Patent il brevetto che ho ideato nelle prime settimane del 2015, mentre lavoravo in IBM:

ON DEMAND SYNCHRONIZATION OF INFORMATION
(Sincronizzazione delle informazioni su richiesta)

Di che si tratta? Di un'idea finalizzata a risolvere un problema classico delle grandi (ma anche delle piccole) organizzazioni: la proliferazione di silos di contenuti completamente scorrelati e disallineati.

Sul tema sono stati scritti fiumi d'inchiostro, spesso invano, nonostante le migliori intenzioni di alcuni manager aziendali "illuminati" e la disponibilità di tecnologie e best practice adatte allo scopo.

A questo punto, è necessario un breve flash-back.

Arrivato in IBM nel ruolo di Documentation Manager di CrossIdeas, ed essendo quindi il massimo esperto della documentazione della piattaforma IDEAS, nei primi mesi di lavoro venni contattato da diversi colleghi di altre aree (training, marketing, integration, etc) che sviluppavano contenuti inerenti al prodotto.

Di fatto, vidi in presa diretta lo sviluppo di diversi "silos" di contenuti.



Inizialmente, tali silos erano legati alla "radice" della documentazione tecnica di prodotto.
Ma in seguito e per tutta una serie di ovvie ragioni, queste aree tendevano a procedere con un certo grado di autonomia, costituendo silos informativi potenzialmente disallineati.

Mi resi conto che questa dinamica implicava un problema: nel momento in cui apportavo una modifica "significativa" alla doc di prodotto (sorgente), questa modifica doveva essere comunicata a tutti i referenti interessati.

Non sarebbe stato opportuno instaurare un "automatismo" per tenere allineati i diversi silos?

Da questa banale osservazione, ideai una generalizzazione della soluzione dell'allineamento dei silos (ATTENZIONE! NON DELL'ELIMINAZIONE DEI SILOS... cosa che ritengo impossibile, specialmente nelle grandi organizzazioni... ma questa è un'altra conversazione).

L'idea è semplice:

  1. Un UTILIZZATORE di contenuti elegge una SORGENTE AFFIDABILE di contenuti e instaura un CONTRATTO con la sorgente.
  2. L'utilizzatore può includere nei suoi documenti dei contenuti pubblicati dalla sorgente.
  3. Quando un contenuto della sorgente cambia, l'utilizzatore ha la possibilità (mai l'obbligo) di aggiornare AUTOMATICAMENTE la variazione.
  4. In questo modo, i documenti dell'utilizzatore sono sempre allineabili con la sorgente.


UN ESEMPIO SEMPLICE

Immaginate di utilizzare delle tabelle della FAO in una presentazione.
Le tabelle, nel tempo, cambiano. Se volete essere certi di utilizzare sempre la tabella più recente, magari dovete andare ogni tanto sul sito della FAO e verificare eventuali variazioni.
Se la tabella è cambiata, dovete decidere se prendere la nuova tabella e aggiornare la presentazione oppure no.

Il paradigma è "L'UTENTE CHE CERCA L'INFORMAZIONE"... ricordate?
Questo paradigma è SEMPLICEMENTE il paradigma SBAGLIATO!

Non sarebbe meglio avere un meccanismo che, al variare della tabella, trasferisce automaticamente la tabella aggiornata nella mia presentazione? Cioè "L'INFORMAZIONE CHE CERCA L'UTENTE"... il paradigma giusto!

Ora allarghiamo il campo di gioco.

Immaginate di avere N documenti che attingono da K sorgenti (di solito con N>K). Ora, al variare dei contenuti di K sorgenti, dovete andare periodicamente a verificare se non sia necessario aggiornare "a mano" gli N documenti.

In questo gioco, voi perdete sempre e perdete tanto più velocemente quanto più alti sono i valori di N e K.

Se invece avete K contratti con le K sorgenti, potete allineare gli N documenti in modo quasi indolore. Ora non entro nei dettagli tecnici del meccanismo (content tagging, notifica della variazione, accettazione, etc), che potete approfondire leggendo il brevetto.

Si pone una sola ipotesi: la sorgente espone contenuti attraverso un linguaggio taggato (XML, HTML, etc).

La bontà del brevetto consiste nel non fare nessuna assunzione specifica sul:

  • tipo della sorgente
  • numero di sorgenti
  • contenuti della sorgente
  • tipo/formato di documenti collegati alla sorgente

Per la precisione, il brevetto è stato realizzato grazie alla preziosa collaborazione di altri 4 colleghi:
Cristina Bonanni, Patrizia Manganelli, Andrea Durastante e Andrea Di Maio.
Devo sottolineare il fondamentale apporto di Cristina e Patriza, perchè io ero al primo brevetto mentre loro avevano già alle spalle diversi brevetti e la loro esperienza è stata decisiva nella formalizzazione di questa intuizione.

Il brevetto è attualmente di proprietà della IBM, a cui abbiamo ceduto tutti i diritti.

Se l'argomento vi interessa e volete approfondirlo mi potete contattare.

Ciao. Leggi questo articolo...

domenica 4 settembre 2016

Quali sono gli strumenti più usati dai professionisti della Comunicazione Tecnica?

Vi segnalo un bell'articolo di Ferry Vermeulen, fondatore di INSTRKTIV, che ha intervistato circa 70 professionisti della Comunicazione Tecnica, responsabili di aziende e liberi professionisti.

Ognuno di essi ha indicato 3 o 4 tool, fra quelli usati con maggiore frequenza nel loro lavoro.

E' un sondaggio che non vuole avere la dignità di una rilevazione statistica, ma credo che sia comunque interessante.

Fra gli intervistati, due persone che mi onorano della loro amicizia, come Marie Louise Flacke e Nolween Kerzreho.

Poi anche l'ideatore di Oxygen, George Bina, con il quale ho avuto modo di scambiare piacevolmente due chiacchiere a Stoccarda, nello stand della sua azienda, nel Novembre del 2015.

Poi Mike Hamilton, il V.P. di MadCap, la cui storia professionale è semplicemente entusiasmante e che vi invito ad approfondire.

Quindi alcuni "guru" della scrittura tecnica che ho sempre avuto come modelli da seguire e che mi hanno insegnato molto (e continunano ad ispirarmi), come Sarah O'Keefe, Tom Johnson e Joe Gollner.

E altri colleghi che hanno fornito la loro opinione, corredandola con una sintetica motivazione.

Al termine dell'articolo, una breve tabella con la "classifica" dei tool più popolari in questa platea di esperti.



Ribadisco che l'autore non voleva realizzare uno studio statistico o una classifica di merito, ma un semplice sondaggio di opinioni.

Del resto, se chiedi a Mike Hamilton quale sia il suo tool preferito, è anche normale che possa indicarti Flare.

E comunque il risultato è interessante, e mi piacerebbe avere un vostro feedback sull'argomento.

Per quello che mi riguarda, negli ultimi 5 anni ho usato diversi tool nel mio lavoro. Come direbbe Rino Tommasi, "nel mio personale cartellino":

Madcap Flare (CCMS)
Oxygen (XML-DITA editor)
DITA (standard per la strutturazione dei contenuti)
Acrolinx (per il controllo linguistico e la guida di stile)
FileNet (CMS)
Word (editor general purpose)
Notepad ++ (editor general purpose)
Camtasia (Video)
Go Animate (Video)

Leggi questo articolo...

venerdì 6 maggio 2016

COMTecnica a Bologna: 11 e 12 Maggio 2016

La prossima settimana a Bologna inizia COMTecnica, il più importante evento del 2016 in Italia.

Si parlerà ovviamente di Comunicazione Tecnica e in particolare di "Intelligent Information", di "contenuti 4.0", quindi di tutto ciò che concerne le tendenze più avanzate in termini di processi, standard e tools per migliorare la produzione della documentazione che accompagna qualsiasi prodotto.

L'evento è organizzato congiuntamente da tekom Europe e COM&TEC,
ed è strutturato su 2 giornate.

Il primo giorno, 11 Maggio, dopo i saluti introduttivi di Tiziana Sicilia, Presidente di COM&TEC, e Michael Fritz, CEO di tekom Europe, avremo diversi interventi di alto profilo.

Isabelle Fleury illustrerà l'impatto delle nuove tecnologie sull'adattamento dei processi e delle procedure di lavoro e come i reparti comunicazione tecnica possono avviare cambiamenti nella loro organizzazione

Michael Fritz parlerà di "Intelligent Information", nello scenario dell''industria 4.0. In futuro, i comunicatori tecnici forniranno le informazioni necessarie in modo individualizzato, esaltando la "user experience", sfruttando i metadati per creare la distribuzione di contenuti dinamici per tutti i supporti di output rilevanti. Il Dr. Michael Fritz, presenterà il cambiamento di paradigma in corso e presenterà "eDOK".

Akash Dubey parlerà di come ottimizzare le risorse aziendali per migliorare i risultati delle diverse aree di un'azienda.

Daniela Straub illustrerà il "tekom competence framework" sviluppato nel 2015, finalizzato ad offrire un approccio sistematico per definire le fasi dello sviluppo della documentazine di un prodotto insieme con le competenze richieste. Lo sviluppo della documentazione di prodotto è un processo che richiede un volume ed una varietà di competenze sempre crescente. Il tekom competence framework è uno strumento di profilazione aperto, in grado di indirizzare al meglio tale processo.

Stefano Lugli parlerà dell'importanza degli aspetti della sicurezza nella documentazione tecnica.
Ai fini della conformità CE delle macchine e impianti immessi sul mercato, è determinante la realizzazione di Documentazione Tecnica (in particolare Manuale d’uso) completa ed efficace (mediamente il 25% delle contestazioni di non conformità riguardano proprio i contenuti delle istruzioni per l’uso e avvertenze).

Yang Sook Kim parlerà delle differenze culturali, in termini di cultura d'impresa e dei comportamenti dei consumatori, tra Europa ed Asia, con particolare attenzione a Cina, Giappone e Corea. Per un'azienda Europea è importante valutare questi aspetti per meglio avvicinarsi a questi mercati. In particolare, per chi scrive documentazione tecnica e per i professionisti del marketing.

Orlando Chiarello parlerà dell'utilizzo dei linguaggi controllati nella definizione dei contenuti con particolare riferimento all'Inglese tecnico semplificato  (STE).

Il 12 Maggio avremo un ricco programma di workshop gestiti da diverse aziende e su diversi argomenti.

Per registrarvi ed essere presenti insieme a noi, potete partire da questo link.

Vi aspetto a Bologna! Leggi questo articolo...

martedì 12 aprile 2016

Nuovo report della DCL/CIDM per il 2016: tendenze nella Comunicazione Tecnica (prima parte)

Tra i tanti account Twitter che seguo, quello della DCL (Data Conversion Laboratory) è tra i più attivi.

I sondaggi della DCL, realizzati in collaborazione con la CIDM (Center for Information Development Management) sono un punto di riferimento per la nostra professione, su scala mondiale.

E' recente la nuova infografica relativi alle tendenze del 2016, basata su 22 quesiti.

Ed è interessante prendersi un poco di tempo per poterla confrontare con i risultati che vi ho proposto negli anni scorsi, in particolare nel 2014.

Di seguito, vi propongo alcuni spunti, come sempre non esaustivi.

Q2: circa la metà dei partecipanti lavora nell'industria del software, circa un decimo in quella delle telecomunicazioni, circa un ventesimo si occupa di documentazione delle macchine e dei semiconduttori, ma molti altri settori sono presenti, se pur con percentuali molto ridotte.

Q3: l'80% degli intervistati produce principalmente manuali utente e circa il 60% lavora per produrre "user assistance"; in questa voce vanno a finire diversi tipi di "embedded documentation", in particolare gli Help on Line. Ma anche i Video sono in crescita, il 33% circa rispetto al 27% del 2014. In calo invece la voce Training Materials, ora al 31% rispetto al quasi 37% del 2014. Questo dato è in linea con le nuove tendenze per cui le aziende si stanno organizzando per produrre training continui sui propri prodotti, sfruttando le tecnologie della FAD on-line (Formazione a Distanza).

Q5 e Q6: in questa coppia c'è uno dei risultati più interessanti: il formato PDF è ancora "the king" ma nei prossimi 2-3 anni si prevede un calo del 35% (ne abbiamo parlato spesso su questo blog, PDF è destinato a divenire solo uno dei tanti, possibil formati), mentre avanzano tutte le modalità web e mobile, che sono intrecciate con la tematica del Dynamic Delivery.

Q9 e Q10: si sta iniziando a ripensare la documentazione per il Mobile e per il Cloud (qui entra pesantemente in campo il problema del Dynamic & Continous Delivery). Tra 3 o 4 anni le pecentuali che vediamo in questo sondaggio saranno almeno raddoppiate, accetto scommesse. Qui i contenuti vanno gestiti in base a divesi criteri, ma direi che 3 concetti di base sono decisivi: single source + conditional filtering + CSS. Ergo, tutti i vecchi contenuti che non entrano in questo schema  sono probabilmente inutilizzabili, vanno ripensati.

Q11: anche per la comunicazione tecnica stanno entrando in campo i Social Media, soprattutto Twitter, soprattutto per catturare l'attenzione del cliente su temi e concetti specifici, non solo di puro marketing. Quindi dovremo riparlare di Minimalismo?

Per ora mi fermo qui. Vi invito ad intervenire, fatemi sapere come la pensate, magari come state operando nella vostra azienda.

Seguirà la seconda parte.

Leggi questo articolo...

giovedì 28 gennaio 2016

Avete bisogno dell'XML? Ecco 8 indicatori da valutare

La mattina del 19 Gennaio ricevo un tweet e vengo a sapere di un post molto interessante di Sarah O’Keefe: Top eight signs it's time to move to XML.

Nel post Sarah mette in fila 8 buone ragioni per adottare processi XML-based nella gestione dei nostri contenuti.

Proverò a riassumere i punti salienti proposti da Sarah (quindi non sarà una traduzione integrale), fermo restando che vi invito a leggere il suo post integrale.

Ma prima una premessa:  quando parliamo di Intelligent Information (e ne parleremo spesso durante il 2016), dobbiamo essere d’accordo su alcune pietre angolari concettuali.

Ho esposto alcuni di questi concetti nel post relativo al tcworld di Stoccarda.

In estrema sintesi:  si parte dall’idea di contenuti modulari e riusabili, quindi contenuti che possono essere profilati per diversi utenti e diversi output di pubblicazione in quanto associabili a specifici TAG e METADATI. E se i contenuti sono espressi  e strutturari attraverso un linguaggio “taggato”, sarà quanto mai immediato implementare tale profilazione. Ecco perché abbiamo bisogno dell’XML, uno standard aperto e interoperabile. Ma qui finisce la mia premessa ed inizia la sintesi del post di Sarah.
----------------------------------------------------

1 - Il vostro sistema è sovraccarico, costoso, inadeguato
Se dovete sostenere dei costi eccessivi per le licenze, se i vostri processi editoriali prevedono troppi passaggi manuali, se i contenuti tradizionali che state gestendo occupano uno spazio eccessivo, se molte persone diverse devono intervenire su questi contenuti, allora XML potrebbe tornarvi utile.

XML non è l’unica risposta a questi problemi, ma  è una risposta molto efficiente.
I contenuti XML occupano meno spazio (la formattazione dei contenuti  non è memorizzata in ogni XML file, ma viene gestita separatamente, attraverso i  fogli di stile (Cascading Style Sheets, CSS).
Per lo stesso motivo, anche i creatori di contenuti sono liberati dal vincolo della gestione della formattazione dei contenuti, che spesso impegna fino al 50% del tempo. Possono anche essere ridotti  o del tutto abbattuti i costi di licenza, perché c’è un ampia scelta di XML di authoring tools che possono essere adottati nel team di sviluppo.


2 - Avete problemi nella gestione della versione dei contenuti
Se il Vostro ambiente di lavoro è condiviso tra diversi autori che intervengono in momenti diversi su una gran volume di contenuti,  uno dei problemi principali risiede nella gestione dell’ultima versione di “quel” file, tra le  tante versioni disseminate in diversi repository.

L’adozione di un CCMS può essere un’ottima risposta, ma implica costi che non possono essere giustificati soltanto per implementare un meccanismo di gestione delle versioni dei contenuti.  I file XML sono file di testo e in tal caso potete utilizzare sistemi meno costosi come Git e Subversion per la gestione della loro versione.


3 - Dovete tradurre e localizzare i vostri contenuti
Finora avete messo in campo degli espedienti per gestire le traduzioni, ma tutti i vostri “trucchi” cadono miseramente se dovete tradurre i vostri contenuti in dozzine di lingue diverse. Se adottate processi inefficenti, perdete tempo e soldi.

La necessità di ottimizzare i processi di traduzione è uno dei maggiori motivi per i quali conviene sviluppare contenuti XML-based, che siano interoperabili con i tool di traduzione più utilizzati dalle agenzie di traduzione.


4 - Dovete usare condizioni complesse
Molti tool non srutturati offrono la possibilità di etichettare delle informazioni appartenenti a contenuti diversi per produrre 2 o più versioni di un documento a partire da un singolo file.
Per esempio, indicando con il flag “Istruttore” le risposte ad un test, un insegnante potrebbe produrre dallo stesso file sia il documento di test delle domande, sia il documento delle risposte.
Nella documentazione del software, gli autori possono creare una versione base di un documento ad una versione avanzata, a partire dallo stesso documento sorgente di base.
Ma quando la situazione si complica?

Immaginate la documentazione di un prodotto che debba essere :
- conforme alle normative di sicurezza USA ed Europee
- utilizzato in diversi ambienti: fabbriche, miniere o rivenditori al dettaglio
- che presenta diversi accessori opzionali, che ne modificano il funzionamento
- che presenta componenti del prodotto comuni a modelli diversi, alcuni dei quali con piccole modifiche

In questo esempio, dovete essere in grado di gestire diversi tipi di filtri e dovete combinarli opportunamente:
- Regolamenti
- Ambiente di lavoro
- Accessorio
- Prodotto (per identificare le varianti in componenti comuni)


In XML, tutto ciò è “gratis” fornito nativamente attraverso il meccanismo dei METADATI.


5 - Nessuna soluzione  “commerciale” (off the shelf) soddisfa i vostri requisiti
Se dovete produrre degli output “esotici” o particolari, nessun tool sul mercato potrebbe essere adatto ai vostri scopi. Per esempio, potreste dover distribuire messaggi d’errore consumabili da qualche software, o delle stringhe di testo compatibili con applicazioni Web o con particolari linguaggi come PHP o Pytthon o conformi allo standard JSON, sempre  più richiesto. Se state immaginando una pipeline per distribuire output in qualche formato non usuale, XML sarà di certo una soluzione più semplice ed economica rispetto ad una qualsiasi soluzione proprietaria, che di solito indirizza solo gli output "standard" (HTML5, PDF, etc).


6 - Avete diversi produttori di contenuti part-time
In molti ambienti XML, il personale full-time è spesso integrato da produttori di contenuti part-time, spesso esperti della materia, chiamati a contribuire allo sviluppo delle informazioni e anche per alleviare la carenza numerica dello staff full-time. Un'altra strategia è quella di utilizzare XML per l’interoperabilità tra reparti diversi . L’interscambio dei contenuti tramite XML consente di risparmiare sul volume dei contenuti e sul tempo di riformattazione .I creatori di contenuti part-time hanno una prospettiva diversa rispetto a quelli full-time.La loro tolleranza per la curva di apprendimento necessaria in questo contesto, generalmente diminuisce con i seguenti fattori:

- Livello di esperienza: gli esperti di una materia vogliono scrivere contenuti solo per il tempo strettamente necessario.
- Livello di remunerazione: porre troppi ostacoli davanti ad una persona che non viene pagata per scrivere contenuti, provocherà la loro fuga dal compito richiesto.
- Poca conoscenza: pochi capiscono il senso della questione, i più probabilmente si opporrano ad ogni cambiamento del flusso di lavoro.

Per tutti questi motivi, la creazione di contenuti XML-based  potrebbe rivelarsi più popolare rispetto all’uso di strumenti lenti e complicati, con l’uso estensivo del copia-incolla.


7 - Metadati
I testi non solo soltanto testo. Bisogna avere la capacità di fornire dati supplementari. Per esempio, c'è bisogno di identificare l’abstract di ogni sezione di una rivista. O si vuole creare un link da una recensione di un libro al sito dove puoi acquistare il libro. Un libro ISBN fornisce l’ identificatore unico che ti serve, ma non vuoi visualizzare il codice ISBN nella recensione, quindi hai bisogno di un metadato.
Nei contesti e con strumenti non strutturati, puoi specificare metadata per un documento (le Proprietà di un documento). Con XML puoi associare un metadato ai documenti ma anche ad ogni singola componente del documento (usando i metadati per filtrare l’output dei contenuti).



8 - Requisiti di integrazione/connessione
In alcuni contesti, il vostro testo deve integrarsi/collegarsi ad altri sistemi.
Di seguito, alcuni esempi:

- Per una procedura di riparazione di un pezzo di una macchina, si potrebbe costruire un collegamento dal pezzo all'inventario della vostra azienda, in modo da verificare se il pezzo è disponibile ed effettuare l'ordine se necessario.
- Per la documentazione del software, la possibilità di incorporare i messaggi di errore e stringhe UI sia nei contenuti e nel software stesso.
- Per i contenuti medici, la capacità di accettare le informazioni da dispositivi medici e modificare le informazioni visualizzate di conseguenza (per esempio, una lettura della pressione sanguigna potrebbe comportare un avvertimento visualizzato nelle istruzioni dispositivi medicali.)

In tutti questi casi, XML può essere d'aiuto.
----------------------------------------------------

Il post di Sarah ha un valore che va aldilà del contenuto specifico. Il messaggio di base è:
"Il vostro vecchio modo di produrre documentazione non strutturata, non regge più!"

Fate un'analisi della vostre esigenze, provate ad usare questa check-list e iniziate a valutare una soluzione. Un processo produttivo della documentazione tecnica XML-based può essere l'inizo della vostra soluzione. Potete immaginare un approccio progressivo, basato sull'integrazione di prodotti diversi, open source, a basso costo; oppure potete affidarvi ad un CCMS proprietario XML-based o potete immaginare soluzioni miste, più articolate, per indirizzare bisogni diversi.



Quello che probabilmente non potete fare è continuare a scrivere documentazione "monolitica", non modulare, non strutturata, non interoperabile, non integrabile: in estrema sintesi, documentazione "poco intelligente".

Leggi questo articolo...

martedì 8 dicembre 2015

tcworld2015 in 3 parole: integrazione, CCMS, standardizzazione

Vi avevo promesso un report su quanto avevo visto e capito (per quanto posso) a Stoccarda, durante l'ultima edizione di tcworld2015, che possiamo considerare di certo la più ricca e importante manifestazione europea sulle tematiche della documentazione tecnica.

Con grande ritardo, ecco le mie annotazioni.

Il filo-conduttore di tutto il convegno è stato quello dell'Intelligent Information e delle sfide che l'avvento dei processi "Industria 4.0" ci imporranno, anche nel nostro specifico professionale.

Su questo filo conduttore si sono innestati diversi concetti, ma se ne devo selezionare solo 3, scelgo questi: integrazione, CCMS, standardizzazione.

In primo luogo, il concetto di integrazione.

La produzione di documentazione tecnica sarà il risultato di un processo in cui molti concetti/elementi/strumenti saranno sempre più integrati tra loro.

Anzi possiamo dire che, come sta succedendo nel mondo ICT, ci si sta spostando dall'idea di "integrazione tra strumenti diversi" verso "piattaforme integrate" che ospitano nativamente gli elementi necessari a gestire il processo di sviluppo della documentazione tecnica.

Gli elementi chiave di questo "mantra" sono:
  • SINGLE SOURCE
  • STANDARDIZZAZIONE e MODULARIZZAZIONE
  • TAGGING e PROFILING
  • PUBBLICAZIONE MULTI-FORMATO

SINGLE SOURCE
Tutto quello che si può ottenere, tutte le tecnologie che possiamo applicare, tutti i processi che possiamo strutturare, possono essere efficaci se si parte dell'idea che i contenuti devono essere
scritti bene e, per quanto possibile, una sola volta, per poi poter essere efficacemente riutilizzati.
 
Il single source è prima di tutto una filosofia di definizione dei contenuti ma poi diventa anche il primo passo che possiamo fare per abbattere i costi di tutta la filiera di redazione.
 
I detrattori argomentano sul fatto che in molti casi le percentuali di riuso di un contenuto possono essere molto basse, ma mentre questa obiezione è tutta da dimostrare, caso per caso, i vantaggi del single sourcing sono ampiamente dimostrabili.
 
 
STANDARDIZZAZIONE e MODULARIZZAZIONE
Per implementare il single source, dobbiamo modularizzare i contenuti e dobbiamo avere delle regole per definire in che modo gestiamo tali moduli.
 
Perchè standardizzare? Perchè uno standard ci rende interoperabili, permette a più persone di cooperare allo sviluppo dei contenuti, condividendo regole e strumenti. Anzi, spesso uno standard ci permette di essere ortogonali e agnostici rispetto al tool di sviluppo.
 
Quale standard? DITA? S1000D? Information Mapping? Functional Design? Dipende. E dipende da molti fattori.
 
Ma la scelta dello standard arriva dopo aver maturato la consapevolezza che una scelta è necessaria.
 
Si possono modularizzare i contenuti prescindendo da uno standard ben definito e riconosciuto? Si, ma è più complicato e ci si lega spesso a doppio nodo con le features dell'ambiente di sviluppo di cui disponete.
 
Altro aspetto: con quale "granularità" spezziamo i contenuti al fine del loro riuso?
Questo tema, spesso ignorato, ha implicazioni sia sul piano della gestione sia sul piano dell'efficacia comunicativa che riguarda l'utente. E anche su questo aspetto pesa la scelta dello standard che volete o non volete implementare.
 
 
TAGGING e PROFILING
Una volta che ho un "chunk"/modulo/fragment/topic d'informazione, posso decidere come taggarlo, in base alla strategia di "publish profiling" che voglio perseguire.
 
Il documento per il tecnico che deve installare il prodotto includerà informazioni diverse da quelle per l'utente che deve usarlo. In questo modo, posso profilare molti documenti diversi, che potranno condividere una certa quota di informazioni comuni ma che si potranno differenziare per i diversi utenti del prodotto.
 
 
PUBBLICAZIONE MULTI-FORMATO
Questo aspetto sta diventando l'elemento più critico di tutto questo processo integrato.
Come ripeto da 3 anni, è finito il predominio del PDF. PDF è ormai solo uno dei possibili output che possiamo fornire e che il mercato richiede. Ma ormai il nostro potenziale cliente usa Internet da 25 anni e i dispositivi mobile da almeno 10 anni.
 
Il suo modo di accedere alle informazioni è cambiato, la lettura selettiva ha sostituto la lettura tradizionale (la lettura gerarchico-sequenziale, quella tipica dei libri e dei manuali).
 
Non è più il tempo in cui gli utenti devono aprire un manuale cartaceo per cercare le informazioni, ma sono le informazioni che devono andare a cercare l'utente, secondo una logica task/context/event driven.
 
La documentazione in formato Web e Mobile non è più un add-on esotico, è il modo più comune in cui desideriamo interagire con la documentazione di un prodotto (vedi Q11 nel sondaggio condotto da CIDM nel 2014).

Analogo sondaggio, nel 2015, conferma tale indicazione (Q13).

Ma come mettiamo insieme tutti gli elementi del mantra - integrazione - ?

Ad oggi, il supporto tecnologico più promettente è quello dei CCMS.
I CCMS sono il substrato che consente di gestire al meglio tutti gli aspetti che vi ho elencato sopra.
Ovviamente, non tutti i CCMS sono uguali e si differenziano ampiamente per l'efficacia di un largo spettro di funzionalità.
Ma il punto chiave non sta nella scelta del prodotto A rispetto al prodotto B: sta nella consapevolezza che senza CCMS non si va lontano nel concetto di integrazione.

Il tema sta diventando talmente strategico da suscitare anche confronti dialettici molto "vivaci".

Io stesso sono stato testimone oculare diretto di una discussione al calor bianco tra Markus Kesseler, esponente di spicco di Schema, una società tedesca che produce un ottimo CCMS, ed alcuni tra i più autorevoli esperti di DITA (Eliot Kimber tra tutti ma non solo).

Ma prima di andare oltre è necessario un chiarimento di contesto: in Germania DERCOM riunisce diverse aziende (e Schema tra queste) che producono dei CCMS non necessariamente conformi ed interoperabili con lo standard DITA.

La loro tesi, volendo sintetizzare, è la seguente:

"Un buon CCMS può fornire agli utenti un valore aggiunto maggiore o che addirittura prescinde da una metodologia di standardizzazione come DITA"
 
DITA diviene un parametro di confronto eccellente, in quanto è lo standard di strutturazione dei contenuti più diffuso in USA, Canada e India.
 
Di contro, gli esperti di DITA hanno sostenuto le giuste ragioni di questo standard, distinguendo chiaramente tra i vantaggi di uno standard aperto e interoperabile come DITA e la possibilità di amplificare e potenziare tali vantaggi con un CCMS che sia in grado ANCHE di "parlare in DITA".

Ai più accorti di voi non sfuggirà la valenza commerciale di questo scontro, ove da un lato consulenti DITA ed aziende che producono CCMS DITA-compliant cercano di conquistare il mercato europeo e dall'altro DERCOM, che propone una legittima visione alternativa.

Le tesi di Kesseler erano attaccabili, essendo incentrate sugli eventuali limiti del DITA Toolkit, cioè dello strumento "minimo" attraverso il quale si può operare per realizzare documentazione in DITA. Ma il DITA Toolkit non pretende di surrogare la logica e le funzionalità di un CCMS.

Se volete maggiori dettagli su questo confronto vi rimando alle opinioni di alcuni altri colleghi, quali Sarah O'Keefe, Keith Shengili-Roberts e Sebastian Gottel.

Tuttavia, il punto non è stabilire chi avesse ragione.

La cosa più interessante che emersa da questo confronto è questa:
si può discutere se e quanto un CCMS debba essere in grado di supportare ANCHE il "content model" di DITA o se il "content model" nativo del CCMS sia, in quanto tale, sufficente alle esigenze degli utenti... quello che non si discute è che risulta molto complicato fare a meno di un CCMS!

Questo non è un blog aziendale, è un "blog puro", dove non devo vendere il MIO prodotto, ma dove la mia esperienza mi consente di scrivere sempre in grande libertà quello che penso, mentre tutti i protagonisti di questo confronto difendono, oltre alle loro idee, ANCHE il loro business.

E da questo confronto ho ricavato alcuni elementi che ritengo scolpiti nella pietra:

- è molto complicato produrre "Intelligent Information" senza il supporto di un buon CCMS

- potete produrre buona documentazione anche senza seguire uno standard di strutturazione dei contenuti, ma in tal caso dovete fidarvi del "content model" di un CCMS proprietario

- la capacità di progettare contenuti ben strutturati è sicuramente facilitata dall'adozione di standard aperti e interoperabili come DITA (ma non c'è solo DITA)

- mai confondere uno STANDARD (DITA) con uno STRUMENTO (un CCMS)

- uno standard come DITA e un CCMS possono sposarsi benissimo per ottenere il meglio di entrambi

Del resto, in passato avevo già preso una posizione netta sulla questione.

Io stesso , quando in CrossIdeas scelsi MadCap Flare, non adottai DITA ma mi affidai alle ottime funzionalità di un ottimo prodotto, ideale per una piccola o media azienda.

Ora che lavoro in una multinazionale che gestisce volumi di documentazione enormi, in diverse lingue, osservo che sarebbe praticamente impossibile gestire tali volumi senza adottare uno standard aperto e interoperabile come DITA, sul quale poi si innestano strumenti in grado di ottimizzare ogni fase del processo di sviluppo dei contenuti.

Non è un caso che oltre il 60% delle maggiori multinazionali in diversi settori (produzione del software, dei semiconduttori, etc.), abbiano scelto di adottare DITA.

Ho cambiato idea? Si e no. Dipende da quello che devo ottenere.

ALTRE IDEE DA STOCCARDA?
A Stoccarda c'erano anche tante aziende di traduzione e produttori di CAT Tools.
Le traduzioni sono spesso l'anello finale della filiera di un processo di documentazione tecnica e incidono non poco sui costi. Non mi stupisce che ci sia un mercato agguerrito, dove diversi protagonisti promettono soluzioni che consentono di ridurre i costi senza scapito di qualità. E anche queste soluzioni vanno ormai nella direzione di una maggiore integrazione.

Altro tema affascinante: la Realtà Aumentata.
Ho visto cose molto interessanti ma non ho ben capito quanto incidano i costi di un processo di documentazione AR based rispetto ad uno tradizionale.
Ho visto un tablet che inquadra un motore e dopo pochi secondi sullo schermo si materializza una matrice attiva di elementi che, opportunamente selezionati, permettono di visualizzare tutte le informazioni inerenti al dettaglio delle singole parti del motore.
L'efficacia comunicativa è fuori discussione, ma era già nota.
Sarebbe bello conoscere l'opinione di costruttori e documentatori di macchine rispetto
alle criticità implicate dalla AR nel definire la documentazione del prodotto.

P.S.

Potete scaricare tutte le presentazioni di tcworld2015 da questo link.

Leggi questo articolo...

giovedì 1 ottobre 2015

Al Tekom Europe Roadshow di Bologna si è parlato del futuro: seconda stella a destra...

Il 24 Settembre COM&TEC è stata protagonista di una delle tappe del Tekom Europe Roadshow, che ha richiamato a Bologna aziende ed esperti di Comunicazione Tecnica, tutti coinvolti nel dibattere il tema dell'Intelligent Information.

I relatori presenti hanno declinato il tema secondo chiavi di lettura tutte diverse, ma se devo fare una sintesi estrema, riesco ad isolare 3 tematiche di fondo:
  • l'integrazione dei processi di documentazione con i processi di sviluppo dei prodotti da documentare
  • l'utilizzo dei CCMS come strumento ineludibile per gestire il ciclo di vita della documentazione
  • il radicale cambio di prospettiva nella produzione della documentazione, in funzione della valorizzazione della User Experience dell'utente, a discapito della vecchia idea della produzione "del manuale" auto-referenziale

INTEGRAZIONE del processo di sviluppo della documentazione con il processo di sviluppo del prodotto

"Agile" ormai non è più solo una parola che aggettivizza le movenze di un campione dello sport, ma una metodologia che, nata originariamente nell'ambito dello sviluppo software, inizia ad essere applicata anche in altri ambiti.

La metodologia di sviluppo Agile prescrive una serie di "dogmi" da rispettare (scrum, sprint, story, task,...) ma anche se non volete implementarla nella sua accezione più ortodossa, sappiate che ogni qualvolta vi trovate all'interno di un flusso di progetto "a cicli brevi", anche se non lo sapete, probabilmente state lavorando con un approccio Agile.

Ma che significa "ciclo breve"? Significa che in un ciclo di lavoro (dalle 2 alle 4-5 settimane) vengono sviluppate, verificate, collaudate e documentate tutte le caratteristiche del prodotto previste per quel ciclo.

Al termine del ciclo, il vostro prodotto/software/sistema/macchina è un oggetto "finito", operativo, che può essere distribuito ai clienti.

Ovviamente, questa metodologia deve essere adattata in base al prodotto da realizzare e vanno tenute in conto tutta una serie di vincoli.

Ma perchè noi comunicatori tecnici dobbiamo spingere ed impegnarci affinchè si diffondano processi Agili?

Tradizionalmente, in moltissimi casi, la documentazione tecnica arriva "a valle" del processo produttivo. L'attività di documentazione, in tal caso, è l'ultimo step del processo produttivo e viene quindi considerato come "un costo necessario" ma da minimizzare, un fastidioso atto dovuto.

Invece, nei processi Agili, che si sviluppano attraverso una sequenza di cicli brevi, OGNI CICLO SI PUO' CHIUDERE SE E SOLO SE la documentazione relativa a quel ciclo E' FINITA E CHIUSA.

Appare evidente che in questo caso la documentazione non è più un fastidioso obbligo di legge da ottemperare, ma diviene parte integrante e strategica del processo produttivo.

CCMS a supporto del ciclo di vita della documentazione di prodotto

L'epoca del technical writer "tradizionale", faticosamente focalizzato solo sulla realizzazione dei contenuti, è alle nostre spalle. La capacità di realizzare contenuti efficaci diviene oggi una condizione necessaria ma non sufficente per qualificare il nostro lavoro. I contenuti sono ovviamente ancora importanti ma diviene "mission critical" la questione della loro gestione.

Alcuni anni orsono, convinsi il management della mia azienda della necessità di modernizzare i processi di sviluppo della documentazione anche grazie a questa slide:


La slide presenta gli elementi essenziali di un processo editoriale efficace, che risponde ad una serie di domande.

Quale tipologia di documentazione devo produrre? Per quale tipologia di utenti? In quali formati dovrò renderla disponibile? Quali saranno le modalità di distribuzione? Quanti writer dovranno aver accesso concorrente ai contenuti? Quale metodologia o tecnologia di strutturazione dei contenuti voglio implementare? Quali meta-dati voglio gestire? Quali criteri e processi di qualità voglio/devo implementare? In quante lingue dovrò tradurre i contenuti? Come minimizzo il Time to Market?

Tutte queste domande e molte altre ancora confluiscono in una sola risposta:
Component Content Management Systems.

Quale CCMS scegliere? E' affar vostro, ce ne sono tanti, ognuno con le sue caratteristiche. Analizzate le vostre esigenze e se avete problemi nell'effettuare tale valutazione, fatevi aiutare da un consulente o venite in COM&TEC per essere più informati sullo sviluppo tecnologico di questi strumenti.
Ma non pensiate di poterne fare a meno.

La documentazione sarà focalizzata sulla User Experience

Su questo blog vi ho raccontato di come stava cambiano il paradigma di interazione tra l'utente e la documentazione: non più l'utente che cerca le informazioni nei manuali, ma le informazioni che vanno a cercare gli utenti (esempio classico: Contextual Senstive Help on Line), sfruttando tutte le aree tecnologiche e gli standard coinvolti in questa evoluzione (mobile, meta-data, Big Data, IoT, HTML5, etc.).

Se qualcuno di voi ha ancora delle perplessità su questo tema, è bene che si sbrighi a chiarirsi le idee, perchè il futuro è già qui.

Come sarà la documentazione prossima ventura?

Sarà attivabile, cioè verrà proposta all'utente al bisogno, e il trigger di attivazione sarà il contesto in cui l'utente si muove, il compito che deve portare a termine e l'evento che determina quel bisogno di informazioni e di documentazione (information Context/Task/Event driven).

Sarà mobile (sia on-line che off-line).

Sarà dinamica, nel senso che alcuni contenuti opportunamante taggati attraverso meta-dati specifci, potranno essere aggiornati automaticamente da sorgenti di dati eterogenee (syndication based contents).

E sarà anche in altri modi, ma SICURAMENTE sarà molto diversa da un manuale tradizionale PDF, che rimarrà solo una delle possibili forme di output utilizzabili per distribuire le informazioni.

E in tutto questo, quale sarà il compito di COM&TEC?

Prendo in prestito e riassumo il concetto fondamentale espresso da Michale Fritz, Presidente di Tekom Europe:

"Dobbiamo diffondere consapevolezza di questo nuovo scenario presso le istituzioni europee e i governi, gli enti di normazione e le aziende private. Ad esempio, occorre ripensare l'obbligo legale di fornire i manuali stampati su carta, nel contesto della digitalizzazione crescente delle informazioni".

In anticipo su questa indicazione, il Presidente di COM&TEC ha già intrapreso una forte azione di sensibilizzazione delle istituzioni e dei maggiori enti territoriali italiani per imbastire le sinergie che possono valorizzare il nostro profilo professionale.

Questa mission COM&TEC la interpreta già da molti anni, innervandola con le attività di formazione e di interazione con il mondo delle imprese e di concerto con altri attori dell'evoluzione tecnica in questo comparto.

Per questo COM&TEC opera insieme a Tekom Europe e collabora in diverse aree, aggiungendo ed integrando le proprie idee, per fornire un supporto sempre più efficace ai soci COM&TEC e al mercato italiano della Comunicazione Tecnica.

In ultimo vi segnalo la nuova e importante iniziativa di Tekom Europe, Intelligent Information Initiative marchio iin, incentrata proprio sulla tematica dell'Intelligent Information.

COM&TEC è nel mainstream di tutto questo e dovete esserci anche voi!



Leggi questo articolo...

domenica 22 marzo 2015

Topic sizing: una riflessione a partire da un post di Mark Baker

Una delle questioni che spesso ci poniamo nell’attività di modularizzazione dei contenuti riguarda “la granularità” di un topic, cioè la dimensione dell’unità informativa che stiamo costruendo.


E’ possibile determinare la “giusta dimensione” di un topic o di un set di topic?

E siamo certi che valga la pena investire le nostre energie in questa direzione?

Queste sono le domande principali che si pone Mark Baker in uno dei post più interessanti che ho avuto modo di leggere ultimamente sul suo sito e al quale vi rimando per una lettura integrale.

Di seguito, vi propongo invece la mia riflessione (le immagini, molto efficaci, le ho prese dal post di Mark).

Idealmente, ci piacerebbe definire una situazione "standardizzata", che potesse andare bene per qualsiasi lettore.


Ma di solito la realtà è diversa.

Lettori diversi potrebbero desiderare diverse quantità di informazioni.

Anche considerando un solo lettore, potremmo scoprire che tale lettore desidera quantità di informazioni diverse in tempi diversi.

Se, ad esempio, devo installare una pompa di sollevamento nel mio giardino, devo sapere fondamentalmente solo 3 cose: come posizionare la pompa  (verticale/orizzonatle), come collegarla all’alimentazione elettrica, come collegarla al tubo di scarico.

Ma dopo N ore di funzionamento, avrò anche bisogno di leggere le indicazioni per la manutenzione.

Ecco un semplice esempio in cui il medesimo lettore (io), nel medesimo contesto,  avrà bisogno, in 2 momenti/eventi  diversi, per due task diversi, di due set informativi diversi.

Questo è il senso di ciò che io intendo per un approccio context/event/task driven.

Volendo generalizzare, le informazioni necessarie per i nostri scopi possono trovarsi in un unico contenitore o possono provenire da contenitori diversi


La lettura è un viaggio di scoperta, e spesso quello che si scopre è che abbiamo bisogno di più informazioni di quanto ci potevamo aspettare.  Spesso, dobbiamo leggere molte informazioni prima di giungere al “nucleo” infomativo che risolve effettivamente il nostro problema

Quello che Baker indica con il termine wayfinding è sostanzialmente diverso per ogni lettore ed è una combinazione unica:
  • di ciò che non sappiamo,
  • di ciò che stiamo cercando di fare
  • di ciò che non abbiamo capito dopo la prima lettura
Volendolo visualizzare graficamente, forse ci piacerebbe che fosse fatto in questo modo:


… ma in realtà, molto spesso, è fatto in questo modo:


L’ultimo diagramma sembrerebbe implicare una buona chiave di lettura:  il focus non dovrebbe essere incentrato sulla ricerca di un corretto “topic-sizing” ma nel rendere il wayfinding del lettore attraverso le informazioni meno caotico e più semplice.

Questa visione tende ad armonizzare la dicotomia tra navigazione e la lettura.

Generalmente, la navigazione “tra i contenuti” è di competenza degli architetti dell’informazione mentre "la lettura dei contenuti" attiene al contenuto in quanto tale, che è di competenza dei redattori.

Ma forse è ora di abbandonare l’idea di separare lettura e navigazione: sono attività integrate, navigo per trovare qualcosa che mi serve e in base a quello che trovo decido se navigare ulteriormente, cioè mi muovo attraverso “insiemi di contenuti”  utilizzando anche motori di ricerca e social media.

Mark Baker usa un’espressione efficace, che potremmo tradurre “navigare seguendo gli indizi”… ed è esattamente quello che facciamo di solito.

Quindi, più che lavorare sulla “dimensione dei topic” dovremmo iniziare a ragionare sul concetto di “unità di navigazione efficace”, cioè un set informativo “abbastanza grande” da ospitare “tutto quello che serve” o almeno provare a tendere  verso questo obiettivo.

Ora provo a definire meglio quello che credo di aver capito del post di Mark,  dandone la mia interpretazione attraverso 3 soli concetti molto schematici:

MOLTI TOPICS “PICCOLI” = INFORMAZIONE POLVERIZZATA che richiede  molti link di navigazione per “tenere insieme” i pezzi

POCHI TOPICS “GRANDI”= navigazione ridotta  ma spesso l'informazione “efficace”  che serve al lettore è DISPERSA in un “volume” eccessivo

NAVIGAZIONE EFFICACE = pochi  topics progettati  per essere “auto-consistenti” e “chiusi”, cioè della dimensione giusta per esprimere ognuno compiutamente un argomento/concetto,  ma pensati per essere “in relazione” tra loro, laddove la “relazione” si esprime:
  • nella “navigazione” tra i topic
  • nella “complementarità” tra i topic
  • nella  “sfericità” dei due elementi precedenti, che identificano lo spazio in cui il wayfinding dell'utente è efficace, cioè riesce a soddisfare il bisogno informativo variabile dell'utente (che varia in funzione di diversi fattori)
Nel prossimo post proverò a fare un esempio pratico. Leggi questo articolo...