Panoramica sui tipi di software per la documentazione tecnica e di prodotto: CMS, ma non solo

Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR)
Tel. / Fax: +39 045 6152381
Web: www.keanet.it | E-mail: info@keanet.it

Contributo alla sistematizzazione della documentazione
tecnica e di prodotto
L’uso di Translation-Memory-System, terminologie, controlli linguistici e linguaggi
controllati, Controlled-Language-Checker, Authoring-Memory-System e ContentManagement-System per supportare la standardizzazione, l’internazionalizzazione, il riuso
e la localizzazione / traduzione di contenuti destinati a documentazione tecnica e di
prodotto multi-destinatario e multi-canale per il mercato globale
Report sul libro in tedesco di Petra Drewer e Wolfgang Ziegler, Technische Dokumentation. Übersetzungsgerechte
Texterstellung und Content-Management (Vogel Business Media, 2010).
Pur risalendo al 2010, il testo di Petra Drewer e Wolfgang Ziegler rimane attuale, perché fornisce un'utile
sistematizzazione dell'ambito della documentazione tecnica, in particolare degli aspetti legati al content management e
alla redazione di contenuti facilmente traducibili e localizzabili.

Sommario
Contributo alla sistematizzazione della documentazione tecnica e di prodotto ................................................................... 1
Globalizzazione, internazionalizzazione, localizzazione e traduzione ................................................................................. 3
Localizzazione e traduzione dei testi ............................................................................................................................... 3
Standardizzazione dei testi di partenza ............................................................................................................................... 5
Standardizzazione dei testi a livello di terminologia ........................................................................................................ 5
Standardizzazione dei contenuti a livello di sintassi ........................................................................................................ 6
Verifica dell’applicazione degli standard lessicali e sintattici ............................................................................................... 7
Riuso dei testi standardizzati............................................................................................................................................... 8
Sistemi di Content-Management (CMS) .............................................................................................................................. 9
Classificazione dei contenuti / Marcatura dei contenuti con metadati ............................................................................. 9
Ricerca dei contenuti ....................................................................................................................................................... 9
Redazione dei contenuti .................................................................................................................................................. 9
Realizzazione dei documenti......................................................................................................................................... 10
Verifica di contenuti e documenti .................................................................................................................................. 10
Pubblicazione dei documenti......................................................................................................................................... 11
Gestione delle versioni (revisioni) e delle varianti ......................................................................................................... 11
Gestione delle traduzioni e delle localizzazioni ............................................................................................................. 11
Gestione del flusso di lavoro (workflow management) .................................................................................................. 11
Report ........................................................................................................................................................................... 12
Rapporto fra CMS e altri tipi di software ............................................................................................................................ 13
Obiettivi di un CMS ....................................................................................................................................................... 13

1
Contributo alla sistematizzazione della documentazione tecnica – Gennaio 2014

Tel. / Fax: +39 045 6152381

Concetti alla base dei CMS ........................................................................................................................................... 14
Modularizzare i contenuti nel CMS ................................................................................................................................ 14
Modelli e granularità dei contenuti ............................................................................................................................. 15
Standardizzazione dei contenuti ................................................................................................................................ 15
Classificazione e metadati ......................................................................................................................................... 15
Varianti ....................................................................................................................................................................... 16
Sinottico dei processi gestiti dai CMS e delle possibili integrazioni fra CMS e altri tipi di software ................................... 17

2

Tel. / Fax: +39 045 6152381

Globalizzazione,
traduzione

internazionalizzazione,

localizzazione

e

Drewer e Ziegler partono dalla considerazione che è sempre più necessario produrre documentazione multilingue, per
motivi normativi e commerciali.
La formula magica è GILT: globalizzazione, internazionalizzazione, localizzazione e traduzione.
Per globalizzazione si intende la decisione strategica dell'azienda di agire sul mercato globale. Essa comporta la
contrazione del ciclo di sviluppo, del time to market e del ciclo di vita del prodotto, nonché l'esigenza di disporre di
prodotti e documentazione localizzati contemporaneamente per tutti i mercati. Product manager, redattori e traduttori
devono lavorare in modo pressoché simultaneo con feedback continui.
L’internazionalizzazione attiene allo sviluppo di prodotti in grado di adattarsi, attraverso varianti, ai mercati di
destinazione.
Per localizzazione e traduzione si intende l’adeguamento della documentazione ai mercati di destinazione. Essa
comprende in particolare i seguenti aspetti:
•
•
•
•

Traduzione
Adeguamento di formati di data, ora, numeri, unità di misura e conversioni, formati di output (da A4 a Lettera
USA)
Adeguamento di pittogrammi, colori, illustrazioni
Adeguamento normativo.

Secondo la concezione funzionalista della traduzione (non resa parola per parola, ma raggiungimento di un obiettivo
comunicazionale) localizzazione e traduzione coincidono.
Nel caso di localizzazioni di prodotti software vanno tenute presenti ulteriori peculiarità:
•
•
•
•
•

Molteplicità del materiale da tradurre (interfaccia, manuale, online help, presentazioni on- e offline)
Coerenza terminologica fra interfaccia e documentazione
Feedback fra sviluppatori e redattori in occasione di update
Diversità fra le lingue in termini di lunghezza, verso, uso di segni di interpunzione, ecc.
Commistione fra codice sorgente e testi da tradurre.

Software dedicati alla localizzazione di software sono Alchemy Catalyst, Multilizer ed SDL Passolo. Essi permettono di
localizzare software a prescindere dall'ambiente di sviluppo e sono in grado di rilevare, ed eventualmente correggere,
errori tipici: lunghezza eccessiva dei testi, traduzioni mancanti o incoerenti, comandi mancati o errati, immagini troppo
grandi o in formati non supportati, ecc.
L’adozione di questi software è consigliata solo per aziende il cui core business è lo sviluppo di programmi destinati al
mercato globale e con team di traduzione interni. Negli altri casi il consiglio è di usare i Translation-Memory-System,
benché sprovvisti di funzioni di verifica dedicate.

Localizzazione e traduzione dei testi
I Translation-Memory-Systems (TMS) non sono sistemi di traduzione automatica, ma sistemi che supportano il processo
di traduzione umano grazie alla gestione, al riconoscimento e al riuso di termini e segmenti di testo in una determinata
lingua di destinazione.
Quando il traduttore importa il testo di partenza, il TMS, dopo averlo segmentato, verifica se nella sua memoria sono
presenti segmenti già tradotti nella lingua di destinazione. Il riconoscimento dei testi può essere:
•
•

Exact (100% o Full) match: corrispondenza esatta al 100% fra segmento da tradurre e segmento presente
all’interno della memoria di traduzione
Exact mach condizionali: corrispondenza quasi esatta, ma con devianze a livello, per esempio, di provenienza,
formattazione, ortografia, presenza di variabili e riferimenti, ecc.

3

Tel. / Fax: +39 045 6152381

•
•
•

Fuzzy match: corrispondenza parziale. Il suggerimento di ripresa è utile solo per corrispondenze superiori al
70%
Nessun riconoscimento, perché non vi sono segmenti corrispondenti in memoria
Silence: quando, pur essendovi segmenti in memoria, il sistema non è in grado di individuare la corrispondenza.

I vantaggi di un TMS stanno principalmente nella coerenza della traduzione e nella riduzione dei costi.
Elementi di criticità sono invece:
•
•
•

Inclusione nella memoria solo di traduzioni di qualità, verificate e approvate
Manutenzione costante di segmenti e termini
Presenza, nella memoria, di varianti dello stesso segmento. Se le varianti sono giustificate da differenti contesti
d’uso, vanno salvate in memoria corredate da opportuni metadati per agevolare il traduttore nella scelta del
segmento corretto. Segmenti ridondanti vanno unificati. Se la ridondanza delle traduzioni è dovuta a originali
ridondanti, è necessario unificare i testi di partenza.

Quest’ultima criticità rimanda al fatto che per utilizzare con successo un TMS è fondamentale che i testi di partenza
siano coerenti, cioè standardizzati.

4

Tel. / Fax: +39 045 6152381

Standardizzazione dei testi di partenza
Prima di adottare un TMS è dunque necessario ottimizzare i testi di partenza con l’obiettivo di renderli coerenti.
L’internazionalizzazione dei testi di partenza, cioè la redazione di testi ottimizzati in vista della loro localizzazione /
traduzione, si deve quindi orientare sul principio della standardizzazione della struttura e del contenuto:
•

•

Standardizzazione della struttura (di cui si occupano i CMS [content management system]:
o Segmentazione, cioè modularizzazione dei contenuti a livelli adeguati di granularità
o Strutturazione dei contenuti in base a modelli (per esempio: warning, procedure, ecc.), che definiscono
tipi di contenuto (obbligatori e facoltativi) e loro sequenza
Standardizzazione del contenuto (di cui si occupano terminologie, controlli linguistici e linguaggi controllati,
Controlled-Language-Checker, Authoring-Memory-System):
o Coerenza
 Ortografia (in particolare di nomi di prodotto, sigle, formati di numeri e date)
 Grammatica
 Terminologia
 Sintassi
o Comprensibilità per il destinatario della comunicazione (neofita, esperto, ecc.) e adeguatezza al tipo di
pubblicazione (manuale, help online, ecc.)
o Eliminazione di riferimenti non necessari a una determinata cultura, in particolare culturali, politici,
istituzionali e geografici
 Gestione controllata di varianti e variabili culturali da localizzare, per esempio:
• Contenuti legali
• Denominazioni di prodotti
• Formati di numeri e date
• Immagini di cui sia necessario l’adeguamento alle consuetudini di una determinata
cultura (per esempio: in Giappone i pittogrammi di warning, caution, note sono
sottotitolati, mentre in Europa di norma non lo sono)
• Pittogrammi e simboli di cui sia necessario l’adeguamento alle consuetudini di una
determinata cultura (per esempio: in Giappone il simbolo della “spunta” da una
connotazione negativa [indica un errore], mentre in Europa ha una connotazione
positiva [indica una cosa fatta])
• Layout (per esempio: formato dei documenti [A4 in Europa, Lettera USA negli Stati
Uniti], font, colori, lunghezza dei testi, codifica dei caratteri, flusso del testo da
sinistra verso destra o viceversa).

Standardizzazione dei testi a livello di terminologia
La prima standardizzazione avviene a livello di terminologia.
Il lavoro terminologico si basa sul triangolo semiotico secondo cui le persone non nominano direttamente gli oggetti, ma
le corrispondenti categorie concettuali al cui interno sistematizzano gli oggetti stessi.
Secondo questo principio, idealmente:
•
•

Ogni definizione rappresenta un solo concetto
Ogni concetto è rappresentato da una sola definizione.

Sinonimi e termini ambigui rappresentano una deroga a questa regola ideale.
Il lavoro terminologico mira quindi a standardizzare l’uso di termini, in particolare di termini di settore, ma – in
particolare nel caso dei linguaggi controllati – eventualmente anche di termini di uso corrente.
I passaggi fondamentali per sviluppare una terminologia, da gestire tramite un’apposita base dati, sono:

5

Tel. / Fax: +39 045 6152381

•
•
•
•
•
•
•

Definire e sistematizzare i concetti
Collezionare i termini, raccogliendoli per esempio dalla documentazione aziendale e/o di competitor, da fonti
orali, da letteratura di settore
Associare i termini ai concetti
Definire qual è il termine preferenziale, in base per esempio a criteri di esattezza, brevità, uso comune, ma
anche di logicità, assenza di connotazioni positive / negative, univocità
Definire quali sono i sinonimi ammessi e non
Stabilire la grafia dei termini
Marcare i termini con metadati che ne specifichino il contesto d’uso.

Standardizzazione dei contenuti a livello di sintassi
Per massimizzare i vantaggi della standardizzazione, essa dovrebbe avvenire non solo a livello terminologico, ma anche
sintattico.
Controlli linguistici e linguaggi controllati si occupano di questo aspetto.
La differenza fra controlli linguistici e linguaggi controllati non è netta. In entrambi i casi si tratta di un uso controllato
del linguaggio, attraverso l’introduzione di limitazioni a livello terminologico e sintattico, espressi, per esempio, da norme
di redazione (guide di stile, style guide).
I linguaggi controllati (come per esempio ASD Simplified Technical English, Caterpillar Technical English, Controlled
Automotive Service Language, Francais Rationalisé, Controlled Chinese, Plain Japanese, Scania Swedish, Siemes
Dokumentationsdeutsch, Simplified Technical Spanish) sono una “forma estrema” di controllo linguistico, codificato e
messo a disposizione di una comunità di utilizzatori vasta, non limitata a singole realtà aziendali (come può essere
invece nel caso delle norme di redazione).
E’ opportuno introdurre controlli linguistici / linguaggi controllati in presenza di:
•
•
•
•
•
•

Volumi elevati di documentazione
Documentazione complessa
Numerose lingue di destinazione
Breve ciclo di vita del prodotto
Team di redazione e traduzione numerosi e delocalizzati
Testi di partenza da redigere non nella lingua madre dei redattori.

I vantaggi principali attesi dall’adozione di controlli linguistici / linguaggi controllati sono:
•
•
•
•
•

Coerenza lessicale e sintattica
Maggiore comprensibilità dei testi
Riuso dei contenuti nella lingua di partenza
Riuso delle traduzioni
o Risparmi di tempi e costi di redazione e traduzione
Sviluppo di una corporate language, parte della corporate identity.

L’adozione di controlli linguistici / linguaggi controllati presenta alcuni elementi di criticità:
•
•
•

Accettazione da parte dei redattori
Processo di adozione lungo e costoso (in termini di: acquisto e personalizzazione di software, integrazione con
altri software, formazione all’uso del software, reingegnerizzazione del processo di redazione)
Potenziale abbassamento della qualità dei testi (che possono suonare “meccanici” al lettore).

6

Tel. / Fax: +39 045 6152381

Verifica dell’applicazione degli standard lessicali e sintattici
Una volta definiti gli standard lessicali (grazie alla realizzazione di basi dati terminologiche) e sintattici (grazie
all’elaborazione di controlli linguistici o all’adozione di linguaggi controllati) è necessario verificarne l’applicazione
all’interno dei segmenti di testo che, opportunamente aggregati, daranno vita alla documentazione tecnica e di prodotto.
E’ opportuno automatizzare la verifica utilizzando software denominati Controlled-Language-Checker (CLC), in grado
di controllare: termini preferenziali; sinonimi ammessi e non; varianti non salvate all’interno della base dati terminologica,
ma morfologicamente vicine alle voci salvate; contesto d’uso basato sul destinatario della comunicazione e/o sullo
schema del documento di destinazione (questo perché, per esempio, determinate sigle o abbreviazioni potrebbero
essere consentite in testi ed elenchi, ma non nei titoli); ortografia e grammatica; sintassi.
Per quanto riguarda la terminologia, i CLC permettono di norma di importare basi dati terminologiche attraverso formati
di interscambio standard quali TBX, MARTIF, OLIF, CSV ed Excel.
I CLC sono di norma integrabili con i più diffusi sistemi di authoring: FrameMaker, Word, Arbortext, XMetal, PDF
(HyperSTE).
Vi sono due tipi di CLC:
•

•

Liberamente configurabili: permettono all’azienda di impostare in base alle proprie esigenze le regole in base
alle quali effettuare le verifiche
o Software CLC liberamente configurabili: Acrolinx IQ Suite e CLAT
Dedicati a un determinato linguaggio controllato
o Software CLC dedicati: Boeing Simplified English Checker, MAXit (STE e Controlled English),
HyperSTE, LantMaster (AECMA Semplified English e altri), IBM Easy English Analyzer,

Al di là della sua configurabilità, ogni CLC può essere basato sull’approccio prescrittivo o poscrittivo:
•

•

Approccio prescrittivo: la base dati del CLC contiene solo i termini e le strutture sintattiche ammessi. Dal punto
di vista redazionale, è consentito solo ciò che è previsto dal CLC. In questo contesto sono fondamentali la
completezza del CLC e la formazione dei redattori, che devono conoscere termini e costrutti ammessi per poter
redigere i testi in modo fluido
Approccio poscrittivo: la base dati del CLC contiene solo i termini e le strutture sintattiche non ammessi. Dal
punto di vista redazionale, è consentito tutto ciò che non esplicitamente vietato dal CLC. I CLC poscrittivi
trovano migliore accettazione presso i redattori, ma producono testi meno coerenti rispetto a quelli prescrittivi.

Al di là del loro contributo fondamentale alla standardizzazione dei testi, i CLC portano con sé alcuni elementi di criticità:
•
•
•

•

Processo di adozione lungo e costoso (in termini di: acquisto e personalizzazione di software, integrazione con
altri software, configurazione e test, formazione all’uso, reingegnerizzazione del processo di redazione)
Accettazione da parte dei redattori
Problemi di silence (errori presenti nel testo, ma non individuati dal CLC) e di noise (errori non presenti, ma
segnalati dal CLC), che evidenziano la necessità che il redattore usi il CLC come un aiuto, senza fidarsi
ciecamente di esso
Difficoltà di interpretazione dei messaggi di errore del CLC, che presuppongono che il redattore padroneggi i
termini del linguaggio grammaticale.

7

Tel. / Fax: +39 045 6152381

Riuso dei testi standardizzati
Terminologie, controlli linguistici, linguaggi controllati e Controlled-Language-Checker risultano particolarmente
utili in fase di redazione di testi standardizzati, e di verifica dell’applicazione degli standard lessicali e sintattici.
Per ridurre tempi e costi di redazione e di traduzione, è necessario che i redattori riusino segmenti di testo
disponibili, anziché redigerne di nuovi e effettuarne la traduzione.
Gli Authoring-Memory-Systems (AMS) aiutano il redattore a individuare i segmenti di testo da riusare.
Il funzionamento degli AMS è affine a quello dei TMS: anche gli AMS agiscono su termini e segmenti di testo,
restituendo corrispondenze esatte o parziali, e specificando grazie ai metadati il conteso di utilizzo di più occorrenze
dello stesso segmento.
Per questo motivo gli AMS sono di norma sviluppati dalle stesse aziende produttrici dei TMS. In alcuni casi, produttori di
CMS (content management system) integrano soluzioni AMS e TMS grazie ad accordi di partnership.
I principali software AMS sono: MindReader, CrossAuthor,SDL Global Authoring Management System, Author-it Xtend,
Acrolinx Intelligent Reuse.
Gli AMS sono di norma integrabili con i più diffusi sistemi di authoring: FrameMaker, InDesign, Word, Arbortext, XMetal,
Flare (CrossAuthor), Autor-it (Acrolinx Intelligent Reuse).
Dati tempi e costi di adozione, un AMS è vantaggioso in presenza di volumi ingenti, di numerose lingue di destinazione
e della possibilità di ottenere rilevanti percentuali di riuso (grazie all’uso dell’AMS, ma anche al fatto che il prodotto da
descrivere è standard, con varianti, modulare o configurabile, ma non sviluppato a progetto). Per esempio, uno studio di
Caterpillar del 1995 evidenzia che al quarto manuale redatto con il supporto di un AMS il tasso di riuso ottenuto era già
del 75%.

8

Tel. / Fax: +39 045 6152381

Sistemi di Content-Management (CMS)
Secondo Drewer e Ziegler, obiettivo primario dei CMS è il supporto dei processi, grazie a cui è possibile migliorare
l'efficacia della documentazione (rendendola coerente e di qualità elevata) e l'efficienza del modo in cui la
documentazione è prodotta (contenendo tempi e costi di redazione e traduzione).
Gli autori articolano il processo di redazione della documentazione tecnica e di prodotto nelle seguenti fasi:
•

Classificazione dei contenuti / Marcatura dei contenuti con metadati

•

Ricerca dei contenuti

•

Redazione dei contenuti

•

Realizzazione dei documenti

•

Verifica di contenuti e documenti

•

Pubblicazione dei documenti

•

Gestione delle versioni (revisioni)

•

Gestione delle varianti

•

Gestione di traduzioni e localizzazioni

•

Gestione del flusso di lavoro (workflow management).

Classificazione dei contenuti / Marcatura dei contenuti con metadati
Drewer e Ziegler sottolineano l'importanza di centralizzare la gestione degli attributi e dei valori utilizzati dai redattori per
marcare i contenuti.
Il CMS dovrebbe permettere di gestire attributi gerarchici e multilingua.

Ricerca dei contenuti
Drewer e Ziegler privilegiano la ricerca in base a metadati rispetto a quella full-text per la maggiore precisione dei
risultati.
Il CMS dovrebbe inoltre permettere di cercare le pubblicazioni che riusano un contenuto dato ed eventualmente di
salvare ricerche ripetitive.

Redazione dei contenuti
Al di là delle funzioni classiche di editing (che includono supporto terminologico, guide alla redazione, linguaggio
controllato e Controlled-Language-Checker, Translation- e Authoring-Memory-Systems), Drewer e Ziegler sottolineano
l'importanza di due funzioni che il CMS dovrebbe supportare:
•

Confronto:
o
o

•

Struttura dei documenti: confronto fra la struttura di due o più documenti (eventualmente anche
mediante l'integrazione con software specializzati in XML-Differencing)
Contenuti: confronto del contenuto di due o più moduli (per esempi: versioni / revisioni dello stesso
modulo; diverse varianti di un modulo)

Riferimenti incrociati: log dei riferimenti non validi in fase di pubblicazione del documento e/o ricerca dei
riferimenti non validi all'interno di uno o più documenti.

9

Tel. / Fax: +39 045 6152381

La documentazione tecnica e di prodotto nasce dall'aggregazione di contenuti (moduli e/o frammenti) in base a regole
date, su una struttura di destinazione vuota ed eventualmente standardizzata (per esempio nel caso si progetti basati su
DITA, S1000D, ecc.).
Le modalità di aggregazione possono essere:
•

Manuale: il redattore seleziona e inserisce a mano sulla struttura di destinazione i contenuti da pubblicare

•

Mediante generazione: selezione e aggregazione dei contenuti sono automatiche. La selezione avviene in
base ai metadati che specificano le condizioni di riuso di un contenuto dato, mentre l'aggregazione avviene in
base a un metadato che specifica la collocazione del contenuto all'interno della struttura del documento di
destinazione. Ogni contenuto può essere riusato in N diverse strutture di destinazione

•

Mediante filtro: il punto di partenza è costituito da un documento "mastro" (detto anche documento "globale" o
"massimale"), che contiene tutte le informazioni relative, per esempio, a un insieme omogeneo di prodotti. Il
documento mastro è realizzato a mano dal redattore. La selezione dei contenuti da includere in un determinato
documento avviene invece in modo automatico, in base ai metadati che specificano le condizioni di riuso dei
contenuti. La struttura di partenza e quella di destinazione dei documenti coincidono.

Interessanti le percentuali medie di riuso dei contenuti proposte da Drewer e Ziegler:
•

Per prodotti standard, comprensivi di varianti, e con l'esigenza di specializzare la documentazione per diversi
destinatari e mercati la percentuale media di riuso dei contenuti si aggira intorno all'80-100%

•

Per prodotti modulari e configurabili (mass customization) la percentuale media di riuso dei contenuti si aggira
intorno al 60-80%

•

Per prodotti a progetto la percentuale media di riuso dei contenuti si riduce al 30-50%, rendendo non sempre
redditizia l'adozione di un CMS

•

Nel caso impianti il collegamento fra contenuti e distinta (BOM - Bill of Material), nonché la marcatura con
metadati dei documenti dei fornitori possono supportare la generazione quanto meno parziale della
documentazione tecnica e di prodotto, giustificando tendenzialmente l'adozione di un CMS.

Verifica di contenuti e documenti
I principali strumenti che i CMS possono mettere a disposizione dei redattori per la verifica di contenuti e documenti
sono:
•

Correttori ortografici

•

Correttori grammaticali

•

Integrazione con Translation-Memory-Systems (TMS)

•

Authoring-Memory-Systems (AMS)

•

DTD (document type definition) e schemi XSD (XML schema definition) per la validazione della struttura dei
documenti

•

Schemi XSD per la validazione di determinati tipi di contenuti, per esempio date, contenuti numerici, sigle, ecc.

•

Modelli relativi alla struttura di contenuti e documenti

•

Gestione di testi automatici (auto-text) multilingue, per esempio per le intestazioni di warning, caution, note,
riferimenti incrociati (vd. capitolo..., vedi figura...), ecc.

•

Note e guide per il redattore.

10

Tel. / Fax: +39 045 6152381

Pubblicazione dei documenti
Al di là del concetto di cross-media-publishing, Drewer e Ziegler sottolineano sia il fatto che MS Word è ancora molto
diffuso come formato di output in particolare nelle aziende medio-piccole, sia il fatto che la maggior parte delle aziende
pubblica la documentazione tecnica e di prodotto su 2-3 media di destinazione.

Gestione delle versioni (revisioni) e delle varianti
Drewer e Ziegler chiariscono in modo puntuale la differenza fra revisioni (definite "versioni" dagli autori) e varianti di un
contenuto:
•

Revisioni / Versioni: per revisione / versione si intende la modifica nel tempo di un oggetto dato (un singolo
modulo, un modello formato da un insieme predefinito di moduli, ecc.), a parità di metadati. I CMS dovrebbero
supportare la gestione dei processo di revisione dei contenuti (redazione / verifica / approvazione). Il CMS
dovrebbe:
o
o

Salvare il contenuto revisionato, ingenerando il ciclo di verifica e facendo scattare l'indice di revisione
interno del contenuto (passaggio da 1.1.1 a 1.1.2). Il CMS può salvare da 1 (l'ultima) a N revisioni
(numero predefinito dal sistema o configurabile). In fase di verifica il contenuto dovrebbe essere
bloccato in scrittura per tutti i redattori, fatto salvo per l'autore e il revisore. Infine, il CMS dovrebbe
permettere di confrontare il contenuto originale con una o più revisioni e/o due o più revisioni fra loro

o
•

Salvare il contenuto originale (approvato e marcato da un determinato indice di revisione, per esempio
1.1.1)

Approvare il contenuto revisionato, facendo scattare l'indice di revisione (passaggio da 1.1.2 a 1.2)

Varianti: le varianti di un contenuto sono oggetti distinti, marcati da metadati distinti. Le varianti sono giustificate
da differenze di prodotto, destinatario, mercato, medium, ecc.

Gestione delle traduzioni e delle localizzazioni
Al di là dell'integrazione più o meno profonda fra CMS e Translation-Memory-Systems (TMS), Drewer e Ziegler
sottolineano l'utilità di una funzione che permetta di cercare all'interno del CMS i contenuti "in traduzione". Quando il
redattore esporta un contenuto da inviare al traduttore, il CMS dovrebbe assegnargli in modo automatico lo stato "in
traduzione", rendendolo così facilmente identificabile.
Oltre alle traduzioni, il CMS dovrebbe supportare la localizzazione, in particolare di:
•

Struttura dei documenti

•

Contenuti da includere nel documento

•

Varianti di contenuti

•

Elementi semantici, per esempio unità di misura e relative conversioni.

Gestione del flusso di lavoro (workflow management)
I CMS possono supportare la gestione del flusso di lavoro a tre livelli:
•

Manuale: è il redattore che attiva a mano i marcatori che contrassegnano lo stato di un contenuto e il sistema
invia eventualmente notifiche via e-mail ai membri del team

•

Guidato dal CMS: il CMS permette di gestire il modello del workflow da supportare, attribuendo a ruoli e utenti le
autorizzazioni necessarie per accedere a fasi, contenuti e funzioni predefiniti

•

Guidato dal software esterni, integrati nel CMS, che supportano eventualmente standard CM II (Configuration
Management II - Per maggiori informazioni: http://www.icmhq.com/index.html).

Il supporto a gestioni non manuali del flusso di lavoro trova applicazione in particolare nelle aziende in cui operano team
di redazione numerosi e delocalizzati, e in settori fortemente proceduralizzati (farmaceutico, medicale, aerospaziale,
ecc.).

11

Tel. / Fax: +39 045 6152381

Report
Infine Drewer e Ziegler accennano alle funzioni di report che i CMS possono supportare. Report relativi, per esempio, al
riuso di documenti e contenuti, al numero di lingue in cui un contenuto è tradotto, al volume complessivo di documenti e
contenuti, ecc.

12

Tel. / Fax: +39 045 6152381

Rapporto fra CMS e altri tipi di software
Drewer e Ziegler sottolineano anzitutto che il concetto di CMS non è univoco, ma fa piuttosto riferimento a una galassia
di software distinti, anche se potenzialmente integrabili. Eccoli nel dettaglio:
•

CMS: sistemi di content management, dedicati alla gestione dei contenuti della documentazione tecnica e di
prodotto. Gli autori notano che spesso i CMS vengono confusi con i sistemi di web content management: ecco
perché i CMS sono denominati anche CCM, ovvero sistemi di component content management

•

WCMS: sistemi di web content management, come per esempio WordPress, Joomla, Drupal, DotNetNuke,
ecc. Si tratta di software di authoring, collaborazione e amministrazione, sviluppati per consentire anche a utenti
"non tecnici" di gestire facilmente siti internet

•

MAMS: sistemi di media asset management, dedicati alla gestione del patrimonio informativo multimediale
dell'azienda (immagini, audio, video, ecc.)

•

DMS: sistemi di document management, dedicati all'archiviazione dei vari tipi di documenti prodotti
dall'azienda

•

PIM e SPIM: sistemi di product information management e di spare parts information management,
dedicati alla gestione di informazioni su prodotti e parti di ricambio.

Come già illustrato nei paragrafi precedenti, a supportare l'attività di redazione e traduzione concorrono anche altri
software, potenzialmente integrabili con i CMS:
•

AMS: sistemi di authoring memory. Suggeriscono al redattore frammenti di testo pertinenti scritti in passato. Il
redattore può quindi decidere se riusare il frammento "la macchina è rossa", suggerito dal sistema, o se è
necessario gestire una nuova formulazione, per esempio, "la macchina è di colore rosso"

•

CLC: controlled language checker o conformance checker, in grado di verificare la conformità di un testo a un
determinato linguaggio controllato, per esempio ASD Simplified Technical English, Caterpillar Technical
English, IBM's Easy English, ecc.

•

TMS: sistemi di translation memory, ovvero di gestione delle memorie di traduzione, specializzati nel riutilizzo a
vari livelli di frammenti di testo già tradotti al fine di standardizzare la traduzione e di ottimizzarne i costi.

Altri software potenzialmente integrabili con i CMS sono:
•

PLM: sistemi di product lifecycle management, dedicati alla gestione del ciclo di vita del prodotto

•

PDM: sistemi di product data management, dedicati alla gestione dei file (CAD, ma non solo) relativi alle fasi
di ideazione, progettazione, produzione e obsolescenza di un prodotto

•

ERP: sistemi di enterprise resource planning. Si tratta dei software "gestionali" che integrano tutti i processi
di business rilevanti per l'azienda: acquisti, vendite, gestione del magazzino, contabilità, produzione, ecc.

•

E-business: dedicati alla vendita online di prodotti.

L'integrazione fra CMS ed "ecosistema informativo" aziendale può essere biunivoca: il CMS può essere predisposto a
ricevere e/o a inviare dati e contenuti da/a altri software al fine di raggiungere l'obiettivo del single sourcing, cioè di
gestire 1 volta il dato / contenuto e di riusarlo N volte all'interno di applicazioni / documenti.

Obiettivi di un CMS
Secondo Drewer e Ziegler gli obiettivi primari di un CMS possono così essere sintetizzati:
•

Ottimizzazione del flusso di lavoro

•

Garanzia della qualità dei contenuti, della loro correttezza (anche dal punto di vista legale), nonché del loro
utilizzo coerente all'interno dei vari media e tipi di pubblicazione

•

Cross media publishing e realizzazione di pubblicazioni mirate a vari tipi di destinatari.

Dal punto di vista del workflow, i CMS tendono a supportare un flusso articolato nelle seguenti fasi:

13

Tel. / Fax: +39 045 6152381

•

Creazione e gestione di moduli di contenuti

•

Creazione e gestione di modelli di pubblicazione

•

Controllo qualità: flusso di redazione, revisione e approvazione, anche con il supporto di software AMS e CLC

•

Classificazione dei contenuti, gestione e assegnazione dei metadati

•

Traduzione: flusso di traduzione, anche con il supporto di software TMS

•

Ricerca finalizzata al riuso dei contenuti

•

Riuso condizionale

•

Aggregazione dei contenuti all'interno della pubblicazione, con riuso del relativo modello di pubblicazione

•

Pubblicazione sui vari media

•

Archiviazione e gestione revisioni.

Dal momento che l'adozione di un CMS richiede all'azienda di modificare sia il workflow che l'approccio ai contenuti, è
necessario svolgere alcune attività propedeutiche per cogliere i benefici potenziali del sistema:
•

Process engineering: revisione del flusso di lavoro

•

Content engineering:
o

Selezione dei contenuti

o

Definizione delle terminologie

o

Definizione e applicazione di classificazioni e metadati

o

Modularizzazione dei contenuti

o

Modellazione dei vari tipi di pubblicazione.

Concetti alla base dei CMS
Drewer e Ziegler elencano i concetti su cui si basano i CMS, al di là delle specifiche soluzioni implementative:
•

Single sourcing: ogni contenuto deve avere un'unica fonte per evitare la proliferazione di ridondanze
incontrollate, che pregiudicano la possibilità di garantire qualità, correttezza e coerenza dell'informazione

•

Riuso dei contenuti: ogni contenuto può confluire in N pubblicazioni veicolate attraverso i vari media (carta,
web, app, ecc.). Il riuso può essere by reference (link fra originale e contenuto riusato) o by value (copia del
contenuto originale nel caso in cui sia necessario personalizzarlo nell'output)

•

Content-variant-management: è finalizzato a gestire le varianti di un contenuto (legate, per esempio, alle
configurazioni del prodotto e a definire le condizioni di riuso mediante appositi metadati)

•

Modulo: si tratta del contenuto "confezionato" come un'unità informativa riusabile (analogo a un "mattoncino"
del Lego). I moduli possono avere vari livelli di granularità: grana più grossa (minore complessità di gestione,
ma maggiore ridondanza, poiché gestiscono i contenuti a livello di blocco o di insieme di blocchi) o più fine
(maggiore complessità di gestione, ma minore ridondanza, poiché gestiscono i contenuti fino a livello di
frammenti da inserire in-line o con cui comporre blocchi di contenuto in base a gerarchie e metadati). Secondo
Drewer e Ziegler non vi sono regole universali per definire la granularità dei moduli

•

Cross-media-publishing: realizzazione automatica di vari tipi di pubblicazione (manuale, help online, catalogo
ricambi, ecc.), mirati a destinatari specifici e veicolati attraverso i vari media.

Modularizzare i contenuti nel CMS
La modularizzazione dei contenuti è un aspetto fondamentale in fase sia di adozione che di utilizzo del CMS. Per creare
e gestire in modo ottimale i moduli di contenuti è necessario tenere in considerazione i seguenti aspetti.

14

Tel. / Fax: +39 045 6152381

Modelli e granularità dei contenuti
Come già sopra osservato, non vi sono regole universali per definire la granularità dei moduli.
Drewer e Ziegler suggeriscono di mediare fra l'approccio bottom up (basato sulle esigenze pratiche di riuso del
contenuto all'interno dei vari tipi di pubblicazione aziendali), e quello top down (basato su standard aziendali, standard di
settore, normative. I principali standard di modellazione dei contenuti sono: DocBook e il più recente DITA in ambito
software; S1000D e S2000M nell'ambito della documentazione tecnica di veicoli civili e militari, e dei relativi cataloghi
ricambi; PI-Mod diffuso in Germania nell'ambito della classificazione di prodotti. Da tenere in considerazione che
l'adozione degli standard risulta in crescita: negli USA, nel settore software, DITA ha una diffusione del 20-50%).

Standardizzazione dei contenuti
Le linee guida per standardizzare i contenuti sono:
•

Unificazione: eliminare differenze di contenuto non necessarie e formattazioni frammiste al contenuto

•

Astrazione: eliminare riferimenti contestuali non necessari, per esempio anche utilizzando disegni e schemi,
anziché fotografie e inserendo all'interno dell'immagine riferimenti numerici, anziché testi

•

Differenziazione: creare varianti di un modulo per differenze di contenuto giustificate da motivi tecnici legati al
prodotto o ad altri fattori, per esempio normativi o legali.

Classificazione e metadati
Metadati e classificazioni sono fondamentali per il reperimento dei contenuti e dunque per il loro riuso.
I metadati possono essere legati al ciclo di vita o alla classificazione del contenuto.
I metadati legati al ciclo di vita possono riferirsi al contenuto, alla traduzione / localizzazione del contenuto in una
determinata lingua, nonché al riuso del contenuto.
In relazione alle fasi di un processo, questo tipo di metadati può essere statico o dinamico. Per esempio:
•

I metadati legati al ciclo di vita del contenuto fanno riferimento al processo di creazione, inserimento, verifica e
pubblicazione del contenuto
o

Metadati statici relativi alle fasi del processo sono, per esempio: nuovo, inserito, approvato, pubblicato

o

Metadati dinamici relativi alle fasi del processo sono, per esempio: in lavorazione, in approvazione, in
pubblicazione. Nell'ambito della gestione del workflow i metadati dinamici possono essere legati a
versioni di lavoro e versioni rilasciate (revisioni) dei contenuti. Nel CMS le versioni di lavoro possono
far scattare un indice nell'ambito di una stessa revisione (esempio: da 1.6 a 1.7), mentre le versioni
rilasciate possono far scattare un nuovo indice di revisione (esempio: da 1.7 a 2.0).

I metadati legati alla classificazione possono essere:
•

Intrinseci (cioè riferiti al contenuto in quanto tale), relativi al:
o
o

•

Prodotto (esempio: descrittivi della classificazione merceologica)
Contenuto (esempio: descrittivi del tipo di contenuto, tipo di topic, fase del ciclo di vita, ecc.)

Estrinseci (cioè riferiti al contenuto in relazione ad altri contenuti e oggetti), relativi al:
o

Prodotto che descrivono (esempio: validità del contenuto in relazione a famiglia, modello, componenti,
ecc.)

o

Contenuto (esempio: validità del contenuto in relazione a tipo di output, destinatari, formato, struttura
dell'output, ecc.).

I metadati possono essere inoltre:
•

Monovalenti o polivalenti, dipendentemente dal fatto che prevedano l'attribuzione di uno o più valori al
contenuto da marcare

15

Tel. / Fax: +39 045 6152381

•

Non gerarchici o gerarchici (nel caso in cui un metadato di livelli inferiore sia dipendente da uno a livello
superiore).
o

Per esempio: i configuratori di prodotto ricorrono a metadati gerarchici, mentre le tassonomie ricorrono
a metadati monovalenti e gerarchici, poiché ogni oggetto è associato a un solo classificatore.

I metadati possono essere associati al contenuto manualmente dal technical writer oppure generati in automatico dal
CMS, per esempio nel caso di metadati relativi al riuso di un contenuto (cioè all'elenco degli output in cui un contenuto è
riusato), all'indice di revisione, a metadati che indicano che un contenuto è "in fase di traduzione" o "di revisione".
Infine, il modello dei metadati può essere libero (cioè sviluppato dall'azienda in base alle sue esigenze operative)
oppure seguirne uno standard (per esempio S1000D, PI-Mod in ambito tedesco, ecc.).

Varianti
La creazione di varianti deve essere giustificata da motivi tecnici legati al prodotto o ad altri fattori, per esempio normativi
o legali. Obiettivo della gestione delle varianti è minimizzare le ridondanze.
La gestione varianti include anche quella di variabili (denominazioni specifiche per mercati e clienti, numeri e definizioni
di posizioni, immagini, ecc.).
Per la granularità, la classificazione e i metadati i varianti e variabili vale quanto già detto a proposito dei moduli.
In fase di adozione di un CMS, come base per le attività di standardizzazione, astrazione e differenziazione è necessario
analizzare un campione significativo di documenti e contenuti tipo, rappresentandoli in una matrice (anche una semplice
tabella di MS Excel) che ne esprima i criteri di standardizzazione, classificazione e associazione di metadati.

16

Tel. / Fax: +39 045 6152381

Sinottico dei processi gestiti dai CMS e delle possibili
integrazioni fra CMS e altri tipi di software
Content-Management-System (CMS):
•

Redazione
o Gestione del processo di redazione
o Standardizzazione della struttura
 Contenuti
• Modularizzazione dei contenuti a opportuni livelli di granularità (insiemi di frasi, frasi
singole, segmenti di frase)
o Libera
o Secondo norme e standard
 Marcatura dei contenuti con metadati
•

Integrazione con altre fonti dati
o Sistemi di Product-Lifecycle-Management (PLM)
o Configuratori di prodotto
o Sistemi gestionali e di Enterprise Resource
Planning (ERP)

 Specifica dei marcatori
Documenti
• Modellazione della struttura dei documenti
o Libera
o Secondo norme e standard
Standardizzazione dei contenuti
 Redazione
• Redazione non assistita
• Controllo linguistico
o Norme di redazione (guide di stile, style guide)
o Interfaccia verso terminologie
o Integrazione di terminologie
• Linguaggio controllato
o Interfaccia verso editor dedicati
o Integrazione di editor dedicati
 Integrazione con altre fonti dati


o

•
•
•

Sistemi di Product-Data-Management (PDM)
PLM; Configuratori di prodotto; Sistemi gestionali ed ERP
o Importazione, link e/o esportazione di dati e/o file

Revisione
o Gestione del processo di revisione
o Revisione
 Revisione non assistita
 Controllo linguistico / Linguaggio controllato
• Interfaccia verso Controlled-Language-Checker (CLC)
o CLC configurabili in base alle regole aziendali di controllo linguistico
o CLC dedicati a un linguaggio controllato

17

Tel. / Fax: +39 045 6152381

•

•

•

•

•

•

Integrazione di CLC
o CLC configurabili in base alle regole aziendali di controllo linguistico
o CLC dedicati a un linguaggio controllato

Varianti
o Gestione delle varianti di contenuto (Content-Variant-Management)
o Gestione delle revisioni di varianti di contenuto
o Integrazione con altre fonti dati
 PLM; PDM; Configuratori di prodotto; Sistemi gestionali ed ERP
• Dati necessari a gestire varianti di contenuto in sintonia con le varianti di prodotto
Traduzione
o Gestione del processo di traduzione
o Traduzione dei contenuti
 Traduzione non assistita
 Interfaccia verso Translation-Memory-System (TMS)
 Integrazione di TMS
Riuso
o Individuazione dei contenuti da riusare
 Motore di ricerca full-text con applicazione di eventuali filtri
 Interfaccia verso Authoring-Memory-System (AMS)
 Integrazione di AMS
o Gestione del riuso
• Specifica delle condizioni di riuso
o Gestione del processo di realizzazione dei documenti
 Aggregazione condizionale dei contenuti
• Manuale
• Assistita
• Automatica
o Selezione basata sull’incrocio fra metadati e condizioni di riuso
o Strutturazione basata sul modello del documento di destinazione
• Specifica delle condizioni di riuso
Pubblicazione
o Cross-Media-Publishing
 Interfaccia per la pubblicazione automatica della documentazione in vari formati (Word,
FrameMaker, InDesign, PDF, HTML, XML, ecc.) e secondo vari standard (DITA, S1000D,
ecc.)
 Integrazione con CMS web, sistemi di e-commerce, ecc.
o Integrazione con sistemi di Document-Management (DMS)
 Archiviazione dei documenti.

Autore: Petra Dal Santo (dalsanto@keanet.it)
www.keanet.it

18

Tel. / Fax: +39 045 6152381

http://blog.keanet.it/

19

Panoramica sui tipi di software per la documentazione tecnica e di prodotto: CMS, ma non solo

Recommended

Recommended

More Related Content

What's hot

What's hot (15)

Similar to Panoramica sui tipi di software per la documentazione tecnica e di prodotto: CMS, ma non solo

Similar to Panoramica sui tipi di software per la documentazione tecnica e di prodotto: CMS, ma non solo (20)

More from KEA s.r.l.

More from KEA s.r.l. (20)

Recently uploaded

Recently uploaded (9)

Panoramica sui tipi di software per la documentazione tecnica e di prodotto: CMS, ma non solo