L’importanza dei metadati nella comunicazione tecnica e di prodotto e come gestirli con Argo CCMS e PIM

I metadati sono importanti per automatizzare la selezione e l’aggregazione flessibile e dinamica di risorse rilevanti contestualmente, nonché per supportare funzioni di elaborazione dei contenuti da parte di agenti software e/o di interazione con i contenuti da parte di persone (es. funzioni di site search e filtri).

Il sistema di gestione dei contenuti Argo di KEA, impiegabile come sistema di component content management e di product information management, mette a disposizione del redattore tecnico numerosi strumenti per gestire i metadati.


È assodato che, anche nell’ambito della documentazione tecnica e di prodotto, gli interlocutori dell’azienda – persone e software – si aspettano di poter interagire con risorse contestualmente rilevanti.

Il presupposto della distribuzione di risorse contestualmente rilevanti è la modularizzazione delle informazioni, facilitata dall’uso di software CCMS (component content management system), PDM (sistemi di product data management) e di PIM (sistemi di product information management).

La modularizzazione trasforma infatti i contenuti in elementi simili a mattoncini Lego, che possono essere aggregati flessibilmente e dinamicamente in output configurati, per esempio, in base al canale, alla piattaforma, al tipo di output, al prodotto/servizio, all’interlocutore, alla situazione e al comportamento dell’interlocutore, ecc.

Ogni output esiste quindi solo a posteriori rispetto al processo di aggregazione di moduli contenutistici adeguati allo scopo da raggiungere di volta in volta.

Il processo di montaggio è guidato da regole, che indicano all’operatore o, più frequentemente, al software quali moduli selezionare, come aggregarli ed eventualmente elaborarli, di quali strumenti di interazione dotarli, ecc.

Nell’ambito della documentazione tecnica (es. manuali di istruzioni, help online, user assistance, ecc.) i contenuti sono tendenzialmente poco strutturati. Le istruzioni di montaggio dei moduli contenutistici hanno quindi bisogno di appigli per potersi applicare. I metadati, definibili come informazioni strutturate su risorse poco o per nulla strutturate, costituiscono questi appigli.

Vi sono numerosi tipi di metadati, ma qui ci concentriamo su quelli descrittivi e amministrativi, poiché sono quelli che l’editore della risorsa (es. l’azienda) associa a essa (mentre i metadati di uso sono quelli che descrivono l’uso della risorsa da parte di utenti anonimi e non. Differiscono dagli altri metadati, perché sono il sottoprodotto dell’attività dell’utente, che interagisce con piattaforme software e risorse. In ambito web sono oggetto delle attività di analytics).

I metadati descrittivi sono tutti quelli finalizzati alla discoverability e alla findability della risorsa.

I metadati amministrativi sono invece quelli tecnici (in genere sono acquisiti in modo automatico all’atto della creazione e modifica della risorsa), strutturali (es. relativi a capitoli e sottocapitoli in cui si articola un manuale di istruzioni, la loro sequenza, ecc.), riguardanti la provenienza (es. la storia della risorsa, la sua relazione con altre risorse), la conservazione (es. come conservare la risorsa, come renderla fruibile nel tempo, come distinguere l’originale canonico da copie e trasformazioni di formato) e i diritti d’autore.

Tutti i metadati sono proposizioni relative alla risorsa cui si riferiscono e che descrivono. Le proposizioni, dette triple, sono formate da:

  • Soggetto: la risorsa descritta
  • Predicato (attributo): esprime la relazione fra soggetto e oggetto
  • Oggetto (valore dell’attributo): entità usata per descrivere il soggetto.

Esempio: Mona Lisa (soggetto) è dipinta da (predicato; attributo) Leonardo da Vinci (oggetto; valore dell’attributo).

I metadati descrivono quindi la risorsa mediante un insieme di coppie di attributo e valore.

Il metodo di composizione delle proposizioni relative a un determinato tipo di risorsa è definito dallo schema, che soprattutto nei contesti online è opportuno che sia condiviso e possibilmente aperto, per garantirne la corretta interpretabilità da parte degli agenti software.

Ogni schema regolamenta, per esempio:

  • L’insieme degli attributi leciti
  • Come estendere e/o specificare gli attributi (esempio: specificare che la data è una data di creazione, modifica o cancellazione)
  • I valori leciti per un attributo.
  • La regolamentazione dei valori assumibili da un attributo può avvenire tramite:
  • Dizionario controllato: lista di valori consentiti. Possono essere fissi oppure creabili in base a una sintassi predefinita (esempio: il formato delle date)
  • Thesaurus: lista di valori + relazioni fra i valori
  • Ontologia: lista di valori + relazioni + regole di inferenza. Esempio di inferenza: se A è la madre di B, in base a una regola (madre = donna) è possibile inferire che A è di sesso femminile. L’inferenza può generare nuova conoscenza e guidare l’azione, anche di software
  • Dizionario incontrollato: l’attributo può assumere qualsiasi valore, come nel caso delle folksonomy supportate dai social network.

Mentre i contenuti della documentazione tecnica sono perlopiù poco strutturati, quelli della documentazione di prodotto (cataloghi, e-shop, schede tecniche, ecc.) sono tendenzialmente strutturati.

Non necessitano quindi di metadati? Tutt’altro!

Il comportamento di Google ci fa capire l’importanza dei metadati e, nello specifico, di metadati regolamentati da uno schema condiviso.

Quando cerchiamo un prodotto su Google, alcuni risultati non sono Snippet tradizionali, ma Rich Snippet, che arricchiscono il risultato per esempio con una piccola foto, stelline relative alla media delle valutazioni, link aggiuntivi, prezzi, ecc.

Google ricava queste informazioni aggiuntive dai metadati della scheda prodotto. Perché Google sia in grado di comprendere e utilizzare correttamente attributi e valori è però necessario che i metadati siano conformi a uno schema condiviso.

Dal 2020 il vocabolario di dati strutturati supportato da Google è Schema.org. Per esempio, ecco lo schema dei metadati relativi a prodotti: https://schema.org/Product

Il software Argo di KEA è un versatile sistema di gestione dei contenuti della comunicazione tecnica e di prodotto, utilizzabile come CCMS e PIM (vedi http://www.keanet.it/argo-ccms-per-documentazione-tecnica-e-di-prodotto.html)

Argo mette a disposizione del redattore tecnico numerosi strumenti per gestire i metadati relativi a singoli moduli contenutistici, topic (insiemi di moduli relativi a un dato argomento) e schede prodotto.

Le Proprietà permettono al technical writer di definire liberamente attributi e dizionari controllati di relativi valori.

Per creare insiemi complessi di metadati il redattore tecnico può mettere in sinergia una serie di strumenti di Argo: gli Stili con cui definire gli attributi, i moduli Testo a cui applicare gli attributi predefiniti, gli InLine in cui gestire per ogni attributo il dizionario controllato dei valori multilingua, nonché i Modelli che permettono di assiemare gli attributi, istanziare gli insiemi laddove serve e gestire localmente gli attributi.

Mentre Proprietà e insiemi di metadati sono assegnabili sia a singoli moduli contenutistici che a topic o schede prodotto (composti da più moduli che formano un’entità di senso compiuto), Destinatari, Bookmark e Flag di Traduzione agiscono a livello di singolo modulo contenutistico.

Nella funzione Destinatari l’attributo è predefinito: si tratta degli interlocutori a cui è mirata la comunicazione tecnica e di prodotto (es. installatori, utilizzatori, manutentori, ecc.), mentre l’insieme dei valori leciti è gestibile liberamente.

I Bookmark sono utili soprattutto quando si tratta di definire lo stato di un contenuto o di un codice prodotto (es. novità, ecc.).

Infine, la famiglia dei Flag di Traduzione definisce lo stato di traduzione di un dato contenuto in una data lingua.

I metadati gestiti e assegnati in Argo possono essere usati dal software stesso oppure essere esportati verso altre applicazioni, assieme ai dati cui si riferiscono.

Il Plugin di Configurazione automatica della documentazione si basa su attributi e valori di Proprietà e Destinatari per selezionare solo i contenuti che soddisfano ai criteri specificati dal technical writer (es. i codici di gruppi e componenti di cui è composto il prodotto, la versione del prodotto, il mercato e la lingua, il destinatario, ecc.) e assemblare in modo automatico l’output (es. il manuale di istruzioni oppure la scheda tecnica del prodotto) (vedi https://www.slideshare.net/keasrl/argo-cms-configuratore-automatico-di-manuali).

Anche le funzioni di impaginazione automatica in documenti in MS Word, di creazione di help online/user assistance in HTML5 e di esportazione di contenuti possono usare Proprietà e Destinatari per configurare l’output in base ai criteri specificati, mentre le funzioni di gestione delle traduzioni usano i Flag di Traduzione per filtrare i contenuti “da tradurre” in una determinata lingua.

Quando non è Argo a produrre l’output finale, il software può esportare o esporre via web service verso l’applicazione preposta alla produzione dell’output non solo i contenuti, ma anche i relativi metadati. Questo approccio è particolarmente utile, quando Argo si integra con applicazioni web di e-shop (e-commerce) e di knowledge base.

Queste applicazioni possono usare i metadati sia per aggregare in modo logico le informazioni, sia per basarvi il funzionamento di motori di site search, ovvero di funzioni di navigazione, ricerca e filtraggio.

Lascia un commento