Comunicazione tecnica: dal contenuto modulare all’output multicanale

Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR)
Tel. / Fax: +39 045 6152381
Web: www.keanet.it | E-mail: info@keanet.it
Comunicazione tecnica: dal contenuto
modulare all’output multicanale
Come i sistemi di CCMS (Component Content Management), e in particolare Argo
CMS di KEA, possono supportare i metodi di Topic Based Writing della
comunicazione tecnica. Alcune riflessioni seguite alla lettura del libro di Mark
Baker, Every Page is Page One. Topic based writing for Technical Communication
and the Web, XML Press, Laguna Hills, California, 2013
Sommario
Il lungo viaggio dal contenuto modulare all’output multicanale ...................................................................... 2
Segmenti di contenuto e variabili...................................................................................................................... 2
Segmento di contenuto................................................................................................................................. 3
Variabile......................................................................................................................................................... 3
Blocco di contenuto........................................................................................................................................... 3
Topic .................................................................................................................................................................. 3
Gestione delle affinità semantiche.................................................................................................................... 4
Mappa dell’output............................................................................................................................................. 4
Condizioni di pubblicazione di topic, blocchi, segmenti e variabili ............................................................... 5
Soft link (symbolic link, symlink) ....................................................................................................................... 5
Output multicanale............................................................................................................................................ 6
1
Topic Based Writing e sistemi di gestione dei contenuti – Maggio 2015

Tel. / Fax: +39 045 6152381
Il lungo viaggio dal contenuto modulare all’output multicanale
Modularizzazione e standardizzazione, single sourcing (gestione univoca), marcatura e uso condizionale,
realizzazione automatica di output (pubblicazioni) multicanale per carta, web, mobile e app, profilazione
(personalizzazione) della documentazione tecnica e di prodotto: sono questi alcuni fra i temi caldi del
Technical Writing.
Questo documento ha lo scopo di illustrare elementi e processi in grado di migliorare l’efficienza nella
gestione dei contenuti e di rendere automatizzabile la realizzazione di output multicanale profilati in
base al destinatario e al contesto di fruizione dei contenuti.
Segmenti di contenuto e variabili
Segmenti e variabili sono frammenti di testo che il comunicatore tecnico può inserire in-line, cioè
all’interno di paragrafi (che possono trovarsi nel testo corrente, in avvertenze, tabelle, didascalie, ecc.).
Inserire in un blocco di contenuto segmenti ha l’obiettivo di ottimizzare il single sourcing (la gestione
univoca dei contenuti) e l’uso condizionale dei contenuti all’interno degli output.
2

Tel. / Fax: +39 045 6152381
Segmento di contenuto
Il segmento si distingue dalla variabile per essere multilingua, ma mono-valore. Il segmento può assumere
un solo valore per lingua.
Per il segmento vanno gestiti metadati (attributi / valori) che ne definiscono le condizioni di USO. In
generale, le condizioni di USO possono riferirsi alla merceologica del prodotto, al mercato, al destinatario
della comunicazione, al tipo di output e al canale di distribuzione, ecc.
Argo CMS dispone di tre strumenti per gestire i segmenti: In-Line (segmenti di testo multilingua), XREF-3 e
XREF-5 (riferimenti multilingua che, nella tabella di destinazione, riusano come link rispettivamente il
contenuto della cella o della riga della tabella di partenza. Si tratta di funzioni utilizzate in particolare nei
cataloghi tecnici per gestire in modo univoco e riusare contenuti relativi a singoli codici articolo). Argo CMS
attualmente non permette di gestire metadati relativi ai segmenti.
Variabile
La variabile è multilingua e multi-valore, può cioè assumere N valori in ogni lingua, in base a determinate
condizioni.
Argo CMS attualmente non permette di gestire variabili.
Per gestire le variabili sono necessari i seguenti componenti:
• Nome della variabile, da inserire all’interno del paragrafo
• Metadati (attributi / valori) che definiscono le condizioni di USO della variabile all’interno del paragrafo
• Valori della variabile, multilingua
• Metadati (attributi / valori) che definiscono le condizioni di USO del singolo valore che la variabile può
assumere.
Blocco di contenuto
Per spiegare la differenza fra blocco di contenuto e topic, Mark Baker fa l’esempio della ricetta: i singoli
ingredienti o la descrizione delle singole fasi sono blocchi di contenuto, mentre la ricetta completa
rappresenta il topic, cioè l’aggregato di informazioni utile al fruitore (per esempio per aiutarlo a portare a
termine un compito, com’è quello di cucinare una pietanza).
Per usare la metafora del Lego, il blocco di contenuto è un mattoncino riusabile con altri mattoncini per
ottenere N costruzioni. Il mattoncino è un elemento distinto, ma non autonomo, perché è funzionale a
integrarsi senza attrito con altri mattoncini per realizzare costruzioni, cioè topic.
Argo CMS permette di gestire blocchi di contenuto e i relativi metadati.
Topic
Il topic è composto da N blocchi di contenuto, che – a loro volta – possono contenere segmenti e variabili.
Nel topic i blocchi di contenuto sono riusati come link.
3

Tel. / Fax: +39 045 6152381
La classificazione dei topic è finalizzata a facilitarne il reperimento da parte dei comunicatori tecnici. La
classificazione dei topic non coincide quindi con la classificazione, cioè con la struttura di un determinato
output (per esempio quella il manuale di istruzioni secondo la Direttiva Macchine).
Per il topic vanno gestiti metadati (attributi / valori):
• Che ne definiscono le condizioni di USO
• Che permettono la generazione automatica di soft LINK, cioè di riferimenti incrociati fra topic
semanticamente affini
• Tipici dell’intestazione di una pagina WEB (per ottimizzare il topic dal punto di vista della SEO [Search
Engine Optimization] in vista della sua pubblicazione online).
Argo CMS permette di comporre topic manualmente (mediante operazioni di drag&drop) oppure
automaticamente (mediante la funzione di auto-configurazione condizionale).
Argo attualmente non gestisce metadati funzionali alla generazione automatica di soft LINK e metadati per
il WEB.
Gestione delle affinità semantiche
Per quanto concerne le affinità semantiche, su cui si basa la generazione automatica dei soft LINK fra topic,
è necessario gestire:
• Concetti, da associare come metadati ai topic
• Correlazione fra concetti
• Direzione, cioè verso della correlazione
• Marcatura dei topic con i concetti gestiti.
Rispetto alla gestione manuale di riferimenti incrociati fra topic, la generazione automatica di soft LINK
risulta vantaggiosa poiché: i link si incrementano in modo automatico nel tempo, in funzione della crescita
del numero di topic e dell’arricchimento dei concetti e delle correlazioni gestite; permette di risparmiare
tempo in fase di redazione e revisione; annulla il rischio di collegamenti mancati, errori e incongruenze
dovute alla soggettività del comunicatore.
Mappa dell’output
La mappa definisce la struttura dell’output, cioè la classificazione gerarchica dei contenuti all’interno di una
determinata pubblicazione. Nelle pubblicazioni cartacee la struttura coincide con il sommario del
documento.
Argo CMS permette di associare topic a mappe manualmente (mediante operazioni di drag&drop) oppure
automaticamente (mediante la funzione di auto-configurazione condizionale).
Dal momento che la struttura dei topic e quella dell’output non coincidono, e che i livelli di titolazione (da
Titolo 1 a Titolo 6) devono seguire la classificazione gerarchica dei contenuti all’interno della pubblicazione,
4

Tel. / Fax: +39 045 6152381
è necessario che nel topic il titolo venga marcato genericamente come “Titolo” (non come Titolo 1, ecc.), e
che il livello di titolazione corretto (Titolo 1, Titolo 2, ecc.) venga attribuito automaticamente in fase di
output, in base all’effettiva collocazione del topic sulla mappa di un determinato tipo di output.
Condizioni di pubblicazione di topic, blocchi, segmenti e variabili
In fase di output è necessario specificare non solo la struttura della pubblicazione (mediante la mappa), ma
anche le condizioni di inclusione o esclusione di topic, blocchi, segmenti, variabili e valori delle singole
variabili.
E’ necessario specificare:
• Quali topic, blocchi di contenuto (inseriti nei topic), segmenti e variabili (presenti nei blocchi) includere
o escludere
• Il valore che ogni variabile deve assumere all’interno di quel determinati output.
Argo CMS attualmente permette di specificare condizioni di inclusione ed esclusione a livello di topic e di
blocco.
Soft link (symbolic link, symlink)
La generazione di soft LINK in fase di output di una pubblicazione si basa su:
• Concetti (cioè metadati di tipo soft LINK) associati ai topic
• Sistema di gestione delle affinità semantiche (che definisce la correlazione e la direzione, cioè il verso
della correlazione fra concetti)
• Topic associati alla mappa ed effettivamente inclusi nella pubblicazione, in base alle condizioni
specificate.
A piè di ogni topic correlato a uno o più altri topic mediante metadati di tipo soft LINK, il sistema di
generazione di soft LINK automaticamente inserisce:
• Il titolo della sezione (per esempio “Link ad argomenti correlati”)
• L’elenco composto da tante voci quanti sono i soft link calcolati
• L’anchor text di ogni voce, in base al titolo del topic di destinazione.
I vantaggi principali della generazione automatica di soft LINK sono:
• Il comunicatore tecnico non deve inserire e manutenere riferimenti a topic correlati
• Il comunicatore tecnico manutiene invece
• Una “tavola delle affinità semantiche”, definendo concetti, correlazioni fra concetti e direzione, cioè
verso delle correlazioni
• La marcatura dei topic con i concetti gestiti nella “tavola delle affinità semantiche”
• I link a topic semanticamente affini sono generati in modo dinamico e contestuale
5

Tel. / Fax: +39 045 6152381
• Nessun rischio di collegamenti mancanti, poiché il sistema tiene conto solo dei topic effettivamente
inclusi in una determinata pubblicazione
• A mano a mano che il numero dei topic aumenta e/o che la “tavola delle affinità semantiche” si
arricchisce, si espandono in modo automatico gli elenchi di “link ad argomenti correlati” a
disposizione dell’utente per approfondire o espandere le sue conoscenze.
Output multicanale
Obiettivo della gestione di topic, blocchi, segmenti, variabili e marcature è la realizzazione automatica di
vari tipi di output multicanale (esempi: manuale di istruzioni su carta; help online e user assistance per il
web, ecc.) per soddisfare i bisogni informativi dei vari destinatari della comunicazione tecnica e di prodotto.
Gli automatismi per la realizzazione dei diversi tipi di output multicanale prevedono:
• Esportazione dei topic in base alla mappa della pubblicazione e alle condizioni di inclusione ed
esclusione specificate
• Inclusione / esclusione dei blocchi di contenuto, dei segmenti e delle variabili in base alle condizioni
specificate
• Valorizzazione delle variabili in base alle condizioni specificate
• Inclusione dei metadati tipici dell’intestazione di una pagina WEB, se l’output è destinato al canale
online
• Attribuzione del corretto livello di titolazione (da Titolo 1 a Titolo 6), in base alla collocazione dei topic
sulla mappa della pubblicazione
• Applicazione delle altre regole logiche e grafiche di “impaginazione”, cioè di presentazione dei
contenuti all’interno della pubblicazione
• Generazione automatica dei soft LINK.
Attraverso moduli nativi e integrazioni con soluzioni di parti terze, Argo CMS supporta la realizzazione
automatizzata di output multicanale.
Autore: Petra Dal Santo (dalsanto@keanet.it)
www.keanet.it
http://blog.keanet.it/
6

Comunicazione tecnica: dal contenuto modulare all’output multicanale

Recommandé

Recommandé

Contenu connexe

Similaire à Comunicazione tecnica: dal contenuto modulare all’output multicanale

Similaire à Comunicazione tecnica: dal contenuto modulare all’output multicanale (20)

Plus de KEA s.r.l.

Plus de KEA s.r.l. (20)

Comunicazione tecnica: dal contenuto modulare all’output multicanale