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
Come scegliere un software CMS per
realizzare manuali di istruzioni e cataloghi
L’estate e la fine dell’anno sono i periodi dedicati tradizionalmente alla software
selection, forse perché le aziende hanno un po’ più di tempo da dedicare ad attività
non di routine o perché hanno più visibilità sul budget.
In questo documento proponiamo una mappa delle parole chiave per la software
selection di CMS per la comunicazione tecnica, cioè di sistemi dedicati alla gestione
dei contenuti e alla realizzazione di manuali di istruzioni, help online, cataloghi
prodotto e, più in generale, di documentazione tecnica e di prodotto multicanale
In fase di software selection è utile disporre di una mappa delle parole chiave, e quindi dei concetti di
fondo, su cui si basano le applicazioni che desideriamo cercare e confrontare fra loro.
Ecco una mappa delle parole chiave relative ai software dedicati alla realizzazione di manuali di istruzioni,
help online, cataloghi prodotto e, più in generale, alla realizzazione di documentazione tecnica (tutorial,
guide rapide, ecc.) e di prodotto (e-commerce, catalistini, listini, schede, ecc.) multicanale, per carta, web,
mobile e app.
Anzitutto, qual è la definizione di questo tipo di software? Come cercarli tramite Google e gli altri motori di
ricerca?
In effetti non esiste ancora una definizione univoca di questo tipo di software, ma le parole chiave più utili
a identificarli possono essere: “cms per documentazione tecnica” o “cms per comunicazione tecnica” (per
non confonderli con i CMS web, cioè con i sistemi di gestione dei contenuti per il web, come per esempio
WordPress), “component content management” (CCMS), “software per creare cataloghi” (oppure manuali,
manuali tecnici, istruzioni), “impaginazione automatica” (aggiungendo eventualmente la specifica: manuali,
cataloghi, word, indesign). In ambito tedesco si sta affermando la definizione di “technisches
Redaktionssystem”, cioè di sistema redazionale tecnico. Naturalmente anche parole chiave relative a
particolari norme, standard e metodologie possono essere utili a individuare il software adatto alle proprie
esigenze, per esempio: Direttiva Macchine, S1000D, DITA, Information Mapping, Funktionsdesign, ecc.
Di solito i CMS per la comunicazione tecnica sono software multipostazione – adatti alla gestione
collaborativa delle attività –, basati su XML e utilizzabili tramite un client desktop. Alcuni programmi sono
fruibili anche in modalità SaaS (Software as a Service) / cloud, tramite browser / client web oppure offline
(cioè in locale sul proprio computer).
I CMS per la comunicazione tecnica di solito permettono di importare documentazione pregressa, già
ottimizzata o da ottimizzare. I formati di importazione più diffusi sono MS Word, ma anche Adobe
FrameMaker, HTML, XHTML e XML.
1
Parole chiave della software selection di CMS per la comunicazione tecnica | Giugno 2015

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
Quali sono i concetti di fondo su cui si basano i CMS per la comunicazione tecnica? Ecco una panoramica,
utile per mappare e confrontare fra loro i principali moduli funzionali dei software:
• Quali logiche stanno alla base dell’editing e della gestione dei contenuti?
• Single sourcing, gestione univoca dei contenuti (gestisco il contenuto e le sue traduzioni 1 volta e li
uso N volte all’interno degli output multicanale)
• Moduli, modularizzazione dei contenuti. E’ possibile articolare i contenuti in:
• Variabili (multivalore da usare in-line, cioè nel flusso del testo)
• Snippet, segmenti di testo (monovalore)
• Moduli, blocchi di contenuti
• Topic (insiemi omogenei di più moduli, che al proprio interno possono contenere variabili e
segmenti)
• Nel suo complesso, questa modalità di redazione dei contenuti è definita “topic based
authoring”, intendendo per “topic” un insieme omogeneo di contenuti finalizzato a
rispondere a un singolo bisogno informativo oppure operativo dell’utente
• Nell’ottica del single sourcing e dell’uso condizionale, ogni contenuto può essere gestito in più
varianti
• Che tipi di contenuto sono supportati?
• Testi, traduzioni, immagini, tabelle, ma anche file multimediali e allegati (per esempio documenti
completi forniti da parti terze)
• Alcuni CMS per la comunicazione tecnica comprendono funzioni di conversione automatica delle
immagini in base all’output di destinazione; strumenti per corredare le immagini di elementi
grafici e testi multilingua; generare in modo automatico bar code, codici EAN e QR code a partire
da valori alfanumerici inserti dall’operatore
• Oltre ai contenuti, i software gestiscono la relazione fra contenuti:
• Link / riferimenti incrociati / ancore inseriti manualmente dall’operatore
• Alcuni CMS per la comunicazione tecnica gestiscono anche: link concettuali (link simbolici,
symlink, conceptual link), generati in modo automatico sulla base di mappe concettuali; link
automatici a elementi di pari grado (precedenti / seguenti), padri / figli di un determinato
elemento; mappe immagine
• Che supporto forniscono i software in fase di editing?
• Terminologia (suggerimento di termini vietati e consentiti)
• Authoring memory, memoria autoriale (suggerimento di testi già presenti all’interno dell’archivio,
con l’obiettivo di standardizzarli e riusarli, anziché scriverli e tradurli ex novo)
2
Parole chiave della software selection di CMS per la comunicazione tecnica | Giugno 2015

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
• Supporto attivo di standard (per esempio DITA, S1000D, ANSI Z535-6, ecc.) e metodologie (per
esempio Information Mapping, Funktionsdesign, Pi-Mode, ecc.)
• Se i contenuti sono gestiti 1 volta e usati N volte, è necessario definire le condizioni di uso dei
contenuti. Come? Attraverso l’utilizzo di:
• Metadati, conditional tag, tag condizionali, marcatori, attributi / valori da associare a: struttura,
moduli, snippet, variabili, valori di una variabile, colonne e righe di tabella
• L’espressione “conditional reuse” (riuso condizionale) indica la modalità di uso (o riuso) dei
contenuti in base alle condizioni specificate
• Oltre ai metadati inseriti manualmente dall’operatore, i CMS per la comunicazione tecnica
gestiscono anche metadati automatici (relativi per esempio a chi e quando ha creato / modificato
un contenuti oppure alle informazioni che corredano i file immagine)
• Finora abbiamo parlato di contenuti, ma il nostro obiettivo è realizzare pubblicazioni specifiche: il
manuale di istruzioni di un determinato modello di macchina, l’help online per un codice matricola, il
catalogo generale o un suo sottoinsieme settoriale, ecc. Come passare dai contenuti alla pubblicazione?
• Progetto, book, TOC (Table of Contents): vari i nomi che i software attribuiscono alle pubblicazioni,
intese come aggregazioni di contenuti in base alla struttura della pubblicazione stessa (che, per le
pubblicazioni cartacee, corrisponde al sommario) e alle condizioni di riuso specificate
• Configurazione automatica, configuratore: permette di automatizzare il processo di aggregazione
dei contenuti, finalizzato realizzare una pubblicazione specifica. Il configuratore può essere guidato
anche da distinte esportate dal sistema ERP aziendale
• Una volta configurata la pubblicazione, è necessario produrre l’output vero e proprio, che può essere –
per esempio – un file di MS Word / Adobe InDesign o FrameMaker, XML, HTML oppure alimentare
direttamente un’applicazione di help online, un CMS web un sistema di e-commerce, ecc. I concetti
chiave sono:
• Multichannel output, output multicanale
• Automazione, pubblicazione automatica
• Impaginazione automatica, automazione editoriale, database publishing (termine caduto un po’ in
disuso)
• Ogni tipo di output e ogni pubblicazione hanno un modo peculiare di presentare i dati, dal punto di
vista logico, grafico e funzionale. Nel CMS per la comunicazione tecnica i contenuti sono neutri rispetto
alla successiva forma di presentazione. Che cosa regola la presentazione delle pubblicazioni?
• Template, fogli di stile, CSS (Cascading Style Sheet per gli output online)
• Quali sono i principali tipi di output di cui è possibile automatizzare la produzione?
• Print: tramite l’impaginazione automatica della pubblicazione in formato MS Word, Adobe InDesign
/ FrameMaker, PDF
3
Parole chiave della software selection di CMS per la comunicazione tecnica | Giugno 2015

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
• Help OnLine (HoL) e Context Sensitive Help (CSH)
• Web, mobile e app: tramite l’esportazione di file HTML, XHTML, HTML 5 oppure mediante
l’alimentazione automatica delle applicazioni sulla base di standard XML
• Altro, per esempio presentazioni di MS PowerPoint
• Le procedure possono realizzare in modo automatico anche copertine, sommari, indici e glossari
delle pubblicazioni su carta (print media), nonché l’interfaccia di navigazione di HoL, CSH, output
su web, mobile e app
• Una volta realizzata la pubblicazione, essa va distribuita ai destinatari della comunicazione tecnica e di
prodotto
• In alcuni CMS per la comunicazione tecnica gli output digitali possono essere distribuiti attraverso
portali di delivery – accessibili via browser web, app / web app e applicazioni offline –, in cui la
fruizione dei documenti è regolata da autorizzazioni.
A vari livelli di complessità i software gestiscono il flusso di lavoro (workflow management) di creazione,
traduzione, approvazione, pubblicazione e revisione dei contenuti, supportando per esempio: stati associati
a strutture e contenuti, autorizzazioni sugli stati, assegnazione e schedulazione di compiti, notifiche e
report. Il workflow management può comprendere anche funzioni di:
• Check-in / -out automatico dei contenuti in fase di modifica per prevenire modifiche concorrenti
• Gestione delle revisioni con: creazione automatica di una nuova revisione al verificarsi di determinate
condizioni (per esempio al raggiungimento di un determinato stato); salvataggio delle revisioni
precedenti; possibilità di confrontare revisioni; possibilità di ripristinare revisioni precedenti;
configurazione dell’output in base a uno o più indici di revisione (branching).
I CMS per la comunicazione tecnica possono essere integrati o integrabili con altri software, per esempio:
• Sistemi gestionali (ERP), come per esempio SAP
• MS SharePoint, sia per leggere / inglobare in fase di output file ivi depositati, sia per depositare in
SharePoint i file di output
• Database terminologici e software di traduzione assistita (CatTool)
• Software per la gestione dell’analisi di rischi, come per esempio SafeExpert e Prisma SafetyGuide.
Per scoprire le caratteristiche di Argo CMS, il CMS per la comunicazione tecnica di KEA, visitate la pagina
http://www.keanet.it/argoManuali.htm.
Per maggiori informazioni, demo e trial chiamateci allo 045 6152381 oppure scriveteci a info@keanet.it!
Autore: Petra Dal Santo (dalsanto@keanet.it)
www.keanet.it
http://blog.keanet.it/
4
Parole chiave della software selection di CMS per la comunicazione tecnica | Giugno 2015