Share |

Metodi e strumenti della comunicazione tecnica

Report sul terzo Open House organizzato da Com&Tec

KEA ha partecipato all'Open House su metodi e strumenti della comunicazione e documentazione tecnica organizzato da Com&Tec il 22 ottobre scorso a Rimini.

Si è trattato di un'occasione di confronto fra operatori del settore, da cui sono emersi spunti interessanti che confermano i punti di forza e contribuiscono alla definizione delle linee di sviluppo future di Argo CMS, il sistema di gestione dei contenuti di KEA, dedicato alla documentazione tecnica.

Documenti tecnici complessi e CMS XML

Gli operatori concordano sul fatto che per la gestione di documenti tecnici (manuali, cataloghi, schede, ecc.) complessi è opportuno ricorrere a un sistema di gestione dei contenuti neutrale rispetto a media e formati di uscita, ma in grado di dialogare con essi utilizzando il formato XML.

Per documenti complessi si intendono documenti:

  • Redatti in modo collaborativo
  • Soggetti a un determinato ciclo di vita e quindi alla gestione di versioni
  • Multilingua
  • Passibili di varianti, per esempio per modelli di un macchinario, destinatari, lingua, mercato, ecc.
  • Pubblicati su medium e in formati vari.

Grazie alle sue caratteristiche, Argo CMS fornisce un supporto adeguato alla gestione efficiente dei contenuti e alla realizzazione di documenti efficaci dal punto di vista tecnico-normativo e marketing.

Riutilizzo dei contenuti

Da un confronto con redattori e technical writer emergono due approcci al riutilizzo dei contenuti.

1. Approccio top-down (dal generale al particolare)

Consiste nella pubblicazioni di varianti di un manuale mastro. Le varianti partono dal manuale mastro e sono targetizzate, ovvero specializzate per esempio per un determinato modello di un macchinario, per un destinatario (installatore, operatore, manutentore, ecc.), per una lingua e un mercato, ecc.

Argo CMS supporta già questo approccio mediante funzioni che sul manuale mastro permettono di:

  • Gestire le versioni, ovvero il ciclo di vita delle parti comuni e di quelle specifiche del manuale
  • Gestire le proprietà atte a marcare i contenuti in base al target cui si riferiscono (modello del macchinario, codici della distinta base, destinatario, lingua, mercato, evento, ecc.)
  • Filtrare i contenuti in base a uno o più marcatori (proprietà), ottenendo automaticamente la variante del manuale mastro.

2. Approccio bottom-up (dal particolare al generale)

Quando è necessario riutilizzare in un più manuali frammenti di contenuto (per esempio singoli paragrafi, tabelle, disegni, ecc.), l'approccio bottom-up risulta più efficiente.
Consiste nella gestione di un archivio di frammenti di contenuti, ovvero di componenti a partire dai quali il redattore assembla il documento.
L'approccio bottom-up non prevede l'esistenza di un manuale mastro; ogni documento è una variante targetizzata, cioè specializzata in base a determinati criteri.

Argo CMS è chiamato a rafforzare il supporto a questo approccio mediante funzioni che permettono di:

  • Gestire frammenti di contenuto multilingua (componenti) riutilizzabili all'interno di più manuali. I componenti potranno essere testi, tabelle, immagini, note, contenuti in-line
  • Gestire versioni e proprietà di marcatura dei frammenti di contenuto
  • Gestire lo stato di avanzamento e lo stato di traduzione dei componenti (Bookmark e Flag di traduzione di Argo)
  • Ricercare i contenuti
  • Esportare e importare i contenuti
  • Assemblare il documento in modo manuale o mediante una procedura assistita, che permetta di filtrare i componenti in base a uno o più marcatori (proprietà).

In entrambi i casi i vantaggi principali del riutilizzo dei contenuti sono:

  • Standardizzazione della formulazione e della presentazione di contenuti che esprimono uno stesso concetto
  • La coerenza, perché concetti uguali sono espressi in modo uguale
  • Il fatto di scrivere e tradurre una sola volta un determinato contenuto
  • Applicazione delle modifiche in un solo punto.

Supporto alla terminologia

Come sottolineato dagli operatori di settore, la definizione e/o l'adozione di un terminologia (cioè del lessico di un settore specialistico) da parte dell'azienda è un'attività da svolgere a monte rispetto all'utilizzo di un sistema di Content Management (CMS) e che ha un impatto sensibile sulla qualità del contenuto, sulla sua manutenilità nel tempo e sul costo della sua traduzione.

Argo CMS supporta la gestione della terminologia, la sua classificazione dal punto di vista concettuale, nonché il suo riutilizzo all'interno di un manuale mastro e delle sue varianti. Come già sopra evidenziato, il supporto andrebbe esteso anche alla gestione di terminologia slegata dal singolo documento e quindi riutilizzabile in più manuali.

Supporto alla standardizzazione e alla modularizzazione dei contenuti

Gli operatori di settore sottolineano l'importanza della standardizzazione e modularizzazione dei contenuti per comprimere i tempi di redazione, raggiungere una maggiore coerenza espositiva e risparmiare sui costi di traduzione, permettendo al traduttore di utilizzare in modo efficiente le memorie di traduzione.

In Argo CMS la possibilità di definire DTD, di riutilizzare testi e immagini (anche generiche), di automatizzare l'assegnazione di pittogrammi ad avvertenze ecc., di gestire note interne per i redattori, nonché di automatizzare la formattazione dei contenuti rappresentano un supporto concreto alle attività di standardizzazione e modularizzazione auspicate.

Gestione del flusso di lavoro

Bookmark e Flag di traduzione sono gli strumenti che Argo CMS mette a disposizione per impostare in modo personalizzato la gestione dello stato di avanzamento dei contenuti nella lingua di riferimento, nonché il flusso di traduzione.

Da un confronto con gli operatori di settore emerge l'opportunità che Bookmark e Flag di traduzione possano essere calendarizzati e collegati a un sistema di notifica via e-mail. Sarebbe così possibile scadenzare le attività e facilitare la comunicazione all'interno del team di redazione e traduzione.

Funzioni per il traduttore

In alcuni contesti non è possibile definire un'unica lingua di riferimento per tutti i traduttori, per esempio: alcuni traducono a partire dall'italiano, mentre altri partono dall'inglese o dal tedesco.
In Argo CMS le funzioni di affiancamento e di esportazione della lingua di riferimento dovrebbero quindi permettere al traduttore di selezionare la propria lingua di riferimento, che può non coincidere con la lingua mastro in cui è stato redatto il manuale (o catalogo prodotti).

Sempre sul fronte delle traduzioni, attualmente Argo CMS permette al traduttore di cercare i contenuti da tradurre, ma non evidenzia le modifiche al testo nella lingua di riferimento, il che aiuterebbe il traduttore ad adeguare in modo più rapido e accurato la traduzione.

Estensione dei formati di uscita

I contenuti gestiti in Argo CMS sono neutrali rispetto al medium (carta, CD-Rom, web, ecc.), al formato di uscita e all'applicazione con cui essa viene realizzata.
Il formato XML è il "ponte" fra Argo e l'applicazione (MS Word, Adobe FrameMaker / InDesign, ecc.) utilizzata per la pubblicazione del documento.

Attualmente Argo permette di pubblicare manuali in formato MS Word, Adobe FrameMaker (mediante l'integrazione fra Argo e il motore di impaginazione automatica FrameEditor) e Adobe InDesign (utilizzando FrameEditor o le procedure di importazione di file XML previste da InDesign).

Inoltre Argo è integrato con le applicazioni web per la gestione di cataloghi prodotto e di funzioni di e-commerce. In questo modo è possibile pubblicare in particolari cataloghi di prodotti, ricambi e accessori.

Da un confronto con gli operatori di settore emerge che sarebbe opportuno ampliare i formati di uscita supportati da Argo in direzione di HTML, HTMLHelp. JavaHelp, WebHelp.
Il supporto di questi formati permetterebbe di sfruttare pienamente la possibilità di inserire in Argo contenuti multimediali: audio, video, 2D e 3D.

 

Autore: Petra Dal Santo