Nell’ambito del programma di formazione di COM&TEC - Associazione Italiana per la Comunicazione Tecnica, il 6 novembre 2013 KEA ha tenuto un corso pratico su “Come utilizzare un CMS per rendere più efficiente la produzione della documentazione tecnica”. Panoramica su esigenze e temi caldi della giornata. Al corso hanno partecipato technical writer provenienti da aziende produttrici e da studi specializzati nella redazione di documentazione tecnica e di prodotto. Il corso è stato incentrato sulle criticità del flusso di lavoro attuale dei redattori, nonché sulle loro aspettative nei confronti di sistemi di gestione dei contenuti (CMS - Content Management System) e di realizzazione automatica di pubblicazioni multicanale (Cross Media Database Publishing). Ne è nato un confronto interessante e appassionato, che si è esteso anche ad altri temi centrali della comunicazione tecnica: documentazione per il mobile (QR e realtà aumentata), norme, standard (in particolare DITA e S1000D), linguaggio controllato.

1. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR)
Tel. / Fax: +39 045 6152381
Web: www.keanet.it | E-mail: info@keanet.it
Da un CMS mi aspetto…
La parola ai technical writer!
Nell’ambito del programma di formazione di COM&TEC - Associazione Italiana per
la Comunicazione Tecnica, il 6 novembre 2013 KEA ha tenuto un corso pratico su
“Come utilizzare un CMS per rendere più efficiente la produzione della
documentazione tecnica”. Panoramica su esigenze e temi caldi della giornata
Al corso hanno partecipato technical writer provenienti da aziende produttrici e da studi specializzati nella
redazione di documentazione tecnica e di prodotto.
Il corso è stato incentrato sulle criticità del flusso di lavoro attuale dei redattori, nonché sulle loro
aspettative nei confronti di sistemi di gestione dei contenuti (CMS - Content Management System) e di
realizzazione automatica di pubblicazioni multicanale (Cross Media Database Publishing).
Ne è nato un confronto interessante e appassionato, che si è esteso anche ad altri temi centrali della
comunicazione tecnica: documentazione per il mobile, norme, standard, linguaggio controllato.
Ecco una breve panoramica sulle esigenze e sui temi caldi emersi durante la giornata.
Recupero della documentazione pregressa
Recuperare la documentazione pregressa in fase di migrazione dalla gestione a mano a quella via CMS
implica lo svolgimento di attività sia teoriche, che pratiche.
Quelle teoriche riguardano la selezione, standardizzazione, granularizzazione, strutturazione e
classificazione dei contenuti da migrare, nonché il loro adeguamento alle principali normative di
riferimento (UNI 13460, UNI 10893, UNI 10653, UNI EN 13306).
Le attività pratiche sono finalizzate invece all’importazione dei contenuti nel CMS. Per ottimizzare i tempi di
migrazione, è previsto che Argo CMS migliori il supporto all’importazione dei contenuti da file MS Word.
Per la strutturazione e classificazione dei contenuti Argo CMS offre invece già strumenti efficaci: in
particolare la funzione Modelli permette di gestire flessibilmente template di contenuti (per esempio:
warning a norma, schede ricambi, ecc.).
Single sourcing
La gestione univoca dei contenuti comuni è percepita come strategica sotto vari punti di vista:
•
•
•
Risparmio di tempi e costi di redazione, revisione e traduzione
Garanzia della correttezza del contenuto veicolato attraverso i vari tipi di pubblicazione e di canali
Standardizzazione della comunicazione (esprimere in modo sempre uguale concetti uguali).
1
Documento di KEA s.r.l. – Petra Dal Santo (dalsanto@keanet.it)

2. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR)
Tel. / Fax: +39 045 6152381
Web: www.keanet.it | E-mail: info@keanet.it
In presenza di team di redazione più numerosi e strutturati è posta l’esigenza di supportare un flusso di
lavoro in grado di minimizzare il rischio di creare contenuti comuni ridondanti.
Attualmente Argo CMS viene incontro a questa esigenza permettendo di ricercare e individuare i contenuti
tramite i suoi due tipi di motori di ricerca (sul singolo documento e globale, su tutti i documenti), di marcarli
e riutilizzarli in modo manuale o automatico.
In realtà caratterizzate da un’organizzazione verticale (piramidale) la gestione delle autorizzazioni di Argo
CMS permette di separare eventualmente le aree di competenza dell’amministratore (creazione, redazione,
revisione, cancellazione dei contenuti comuni) da quelle del redattore (ricerca e riutilizzo dei contenuti
comuni).
In realtà organizzate in modo orizzontale questa distinzione non è funzionale: integrando Argo CMS con le
autenticazioni su SQLServer (Windows o SQL authentication) e con un apposito software di audit
(http://www.apexsql.com/sql_tools_audit.aspx) è possibile autorizzare all’editing tutti i redattori,
tracciando però modifiche e relativi autori.
Riutilizzo dei contenuti comuni
Per riutilizzare i contenuti comuni in modo efficiente è necessario marcarli per definirne le condizioni di
riutilizzo. Sono emersi alcuni tipi di condizioni particolarmente rilevanti:
•
•
•
Dati relativi al prodotto. Per esempio: denominazione di famiglie e modelli, codici della distinta
base (BOM - Bill of Material), codici di accessori, ecc.
Destinatari della documentazione. Permette di realizzare documentazione mirata per utenti interni
all’azienda (procedure di assemblaggio per la produzione, offerte per l’ufficio commerciale, ecc.),
prospect e utilizzatori
Mercato di destinazione del prodotto. Per esempio per includere o escludere passaggi riferiti a
normative in vigore in determinate aree o nazioni.
Argo CMS è dotato di un sistema flessibile di gestione della marcatura e supporta sia il riutilizzo manuale
dei contenuti (mediante drag&drop), sia l’autoconfigurazione e autocomposizione di documenti a partire
dalla specifica delle condizioni di riutilizzo da applicare. Per esempio è possibile chiedere ad Argo CMS di
configurare e comporre in modo automatico un manuale che includa tutti i contenuti relativi a un
determinato insieme di codici (della distinta base, degli accessori, ecc.), a un determinato mercato (USA,
anziché Europa) e a un determinato destinatario (installatore e tecnico del cliente, anziché operatore).
Per garantire una struttura corretta e coerente dei documenti, Argo CMS permette inoltre di gestire
template per i vari tipi di documenti e di “mappare” su di essi i contenuti comuni ripresi.
Gestione di contenuti specifici
Poter gestire contenuti specifici, relativi per esempio al manuale di una commessa, è tanto rilevante
quanto il riutilizzo dei contenuti comuni. In particolare è stata sottolineata l’importanza della gestione di
variabili all’interno del documento, relative per esempio al codice matricola.
2
Documento di KEA s.r.l. – Petra Dal Santo (dalsanto@keanet.it)

3. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR)
Tel. / Fax: +39 045 6152381
Web: www.keanet.it | E-mail: info@keanet.it
Entrambe le esigenze sono supportate da Argo CMS, con in più la possibilità di trasformare in comune un
contenuto specifico. Questo è necessario per esempio quando un componente, inizialmente realizzato a
progetto per un cliente, finisce per rientrare nella produzione standard dell’azienda.
Migliorare il flusso di informazioni fra uffici di una stessa azienda e/o fra
azienda e professionisti esterni
Technical writer interni all’azienda e professionisti esterni condividono l’esigenza di migliorare il flusso delle
informazioni fra i vari uffici che concorrono alla gestione dei contenuti della documentazione e/o fra
azienda e parti terze (consulenti, redattori, traduttori, ecc.). Le aspettative di ottimizzazione riguardano in
particolare i seguenti punti:
•
•
•
Permettere ai vari attori di conferire e revisionare i contenuti di propria pertinenza, salvando i
contenuti originali (cioè quelli che il technical writer provvederà a rielaborare) e tenendo traccia
delle revisioni. Argo CMS supporta la gestione collaborativa dei contenuti (con la sua gestione delle
autorizzazioni), permette di salvare e marcare i contenuti originali, di gestire “note per i redattori”,
nonché di tracciare le revisioni grazie all’integrazione con le autenticazioni su SQLServer e con il
software di audit sopra indicato
Realizzare bozze del manuale. L’impaginazione automatica da Argo CMS in MS Word è il modo più
semplice per produrre bozze del manuale, che possono visualizzare anche i marcatori utilizzati per
contrassegnare per esempio “note per i redattori”, contenuti da completare, da rivedere, da
correggere o da tradurre
Agevolare la ricerca dei documenti consegnati al cliente. Al di là degli strumenti standard di
classificazione dei documenti, per Argo CMS possono essere sviluppati Plugin a progetto che lo
integrano con il sistema gestionale dell’azienda (per esempio per collegare documentazione
tecnica, clienti e commesse) o con sistemi PLM (Product Lifecycle Management) / PDM (Product
Data Management) in cui archiviare gli output realizzati a partire da Argo CMS.
Output
MS Word, Adobe InDesign, PDF e, in misura minoritaria, Adobe FrameMaker sono i formati di output più
diffusi.
E’ sentita l’esigenza di disporre anche in un output in formato HTML, per esempio per pubblicare schede
prodotto sul web o per mettere a disposizione di installatori, operatori e manutentori documentazione
fruibile via mobile.
Interessante il dibattito relativo al quesito se sia preferibile il formato Epub o HTML per la fruizione via
mobile: netta la propensione verso il formato HTML, abbinato eventualmente a codici QR in grado di creare
una relazione diretta fra oggetto fisico e documentazione online (per esempio per far accedere in modo
immediato e contestuale l’installatore a un video o il manutentore a una scheda ricambi o l’operatore alla
guida al troubleshooting, ecc.), tenendo d’occhio le prossime evoluzioni nel settore della realtà aumentata
(AR - Augmented Reality).
In fase di output gli aspetti percepiti come rilevanti sono:
3
Documento di KEA s.r.l. – Petra Dal Santo (dalsanto@keanet.it)

4. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR)
Tel. / Fax: +39 045 6152381
Web: www.keanet.it | E-mail: info@keanet.it
•
•
•
•
Gestione di template di presentazione del contenuto. Dal momento che in Argo CMS il contenuto
è separato dalla forma, la presentazione è gestita dal template / foglio di stile associato all’output.
Allo stesso contenuto può quindi corrispondere un numero non predefinito di visualizzazioni
Generazione di indici analitici, indici per codice articolo, ecc. In Adobe InDesign e Adobe
FrameMaker è possibile generare indici a fronte dell’inserimento in Argo CMS degli opportuni tag,
che indichino al software di impaginazione quali voci considerare
Possibilità di sviluppare automatismi per rigenerare in automatico gli output a fronte delle
modifiche dei documenti in Argo CMS. L’obiettivo è raggiungibile con lo sviluppo di Plugin a
progetto
Realizzazione automatica di vari tipi di pubblicazione per vari tipi di canale. Fra gli esempi citati:
manuali, data sheet, procedure di assemblaggio per la produzione, offerte, cataloghi prodotti /
ricambi, schede prodotto per il web. Marcando opportunamente i contenuti in Argo CMS è
possibile automatizzarne l’inserimento all’interno di uno o più tipi di pubblicazione. Per quanto
riguarda la cataloghistica, è possibile sviluppare Plugin a progetto che allineino Argo CMS al sistema
gestionale (ERP) dell’azienda: il sistema gestionale conferisce ad Argo CMS codici articolo,
classificazioni merceologiche, descrizioni brevi e altri dati da esso gestiti, garantendone univocità e
correttezza; in Argo CMS i product manager arricchiscono le informazioni base provenienti dal
sistema gestionale (con disegni, immagini, logo e pittogrammi, video, allegati, descrizioni estese,
traduzioni, caratteristiche tecniche, ecc.) con l’obiettivo di pubblicare la documentazione di
prodotto.
Altri temi
Due i temi caldi dibattuti e sui quali sono ipotizzabili sviluppi futuri di Argo CMS: il supporto degli standard
DITA (http://dita.xml.org/) e S1000D (http://www.s1000d.net), nonché lo sviluppo e il supporto di
linguaggio controllato in lingua italiana per la documentazione tecnica.
In Argo CMS vanno già in questa direzione la gestione dei Modelli di contenuti e il correttore ortografico,
che supporta dizionari standard e glossari personalizzati e che potrebbe evolversi verso un sistema di
scrittura assistita (con funzioni di autocompletamento).
4
Documento di KEA s.r.l. – Petra Dal Santo (dalsanto@keanet.it)