documentazione-modulare

Cos’è la modularizzazione? Concetti di base per i tuoi contenuti

Utilizzando un sistema di gestione modulare dei contenuti (CCMS) come SCHEMA ST4, è possibile gestire il contenuto sotto forma di moduli, topic o nodi. Tra le altre cose, questo significa che devi solo creare una singola sezione per un capitolo una volta e poi riutilizzarla in diversi luoghi. Le modifiche alla sezione originale vengono automaticamente inserite nelle sezioni ripetute.

In questo post, daremo un’occhiata a cosa significa essenzialmente la modularizzazione e, in definitiva, come lavorare con i moduli in SCHEMA ST4.

In un CCMS, non è più possibile gestire il contenuto in modo lineare, come in un singolo documento continuo; invece, il contenuto è creato da sezioni o capitoli, cioè “modularmente”, e viene compilato alla fine per creare la struttura finale.

 

Iniziamo con termini semplici: un nodo è un’unità di contenuto autonomo con una funzione specifica, ad esempio un avviso di sicurezza: “Attenzione: indossare equipaggiamento protettivo”. Un nodo è un’unità di contenuto. Il nostro avviso di sicurezza è stato creato, poiché può essere utilizzato in vari capitoli e documenti. 

La dimensione del nodo dipende essenzialmente dal modello di informazioni CMS. Qui, si potrebbe pensare che più si frammenta il contenuto, più diventa flessibile e “pronto all’uso”. Questo, tuttavia, non è sempre il caso, come vedremo.

Inoltre, possiamo dire che il contenuto che gestiamo e mappiamo modularmente in un CCMS è generalmente destinato ai testi funzionali. Queste potrebbero essere istruzioni operative, analisi degli errori o anche testi di marketing come schede prodotto e cataloghi.

Tipici moduli nei testi di questo tipo includono descrizioni brevi dei prodotti sotto forma di testo scorrevole, avvisi di sicurezza, dati tecnici, grafici, designazioni di prodotti, ecc.

Il nostro esempio pratico: una tabella di manutenzione

Che aspetto ha la modularizzazione tipica in ST4? Consideriamo un estratto da un capitolo di manutenzione in una serie di istruzioni operative.

Esempio di tabella di manutenzione

Diamo un’occhiata a come possiamo modularizzare questa sezione.

Identificare i nodi

La forza di un CCMS risiede, in particolare, nella creazione modulare del contenuto. Una delle sue migliori caratteristiche è che devi solo creare contenuti, ad es. un avviso di sicurezza, una volta sola e può quindi riutilizzarlo nelle aree specifiche del documento dove è necessario. Le seguenti domande sono utili per identificare innanzitutto, dove una sezione, una tabella, un’immagine, possono essere riutilizzati in più testi: in che modo le varianti differiscono l’una dall’altra? Dove posso riutilizzare i contenuti? Qui puoi vedere che, quando usiamo il termine modularizzazione, parliamo automaticamente anche del riutilizzo, cioè ripetutamente facendo riferimento a un nodo, ad es. un grafico, una cella di tabella o una sezione in un altro contesto, disposti in modo tale che il contenuto sia coerente e adatto a tutti i contesti. Se le varianti di testo sono diverse in termini di contenuto, è necessario considerare la posizione nel testo e le dimensioni del nodo. Questi possono, ad esempio, coinvolgere gli stessi gruppi di prodotti, come articoli per la casa. Oppure possono essere intesi per l’utente finale e quindi essere formulati in modo diverso rispetto ai testi destinati ai fornitori, ecc.

La granularità dei moduli

In ST4, è possibile, ovviamente, utilizzare i nodi come descritto qui in varie dimensioni e per vari scenari di riutilizzo. Essenzialmente, ci sono due categorie che determinano la dimensione e l’uso di un nodo: stai modularizzando a livello di sezione (categoria 1) o a livello di parola (categoria 2)? I seguenti criteri ti aiuteranno a prendere la decisione opportuna:

Categoria 1: Modularizzazione a livello di sezione

  • Frasi intere, paragrafi o capitoli che possono essere riutilizzati in differenti contesti. La lunghezza del testo e dei nodi, varia a seconda delle esigenze.

Categoria 2: Modularizzazione a livello di parola

  • Termini fissi come nomenclatura di prodotti vengono raggruppati in un’unica variabile filtrabile.

Glossario: Modularizzazione

Ci sono diverse possibilità per creare questi nodi nell’information pool di ST4. Definiamo come:

Frammento

Un frammento è un contenitore inteso per il riutilizzo al livello sezione. La dimensione minima è una sezione. Il frammento deve sempre essere inserito in un nodo.

Risorse grafiche

Le risorse grafiche sono salvato in un contenitore che può essere paragonato con un diamante. Possono essere language neutral. In quel caso sono sempre pubblicato nella stessa maniera. Ma possono anche variare automaticamente secondo la lingua di pubblicazione.

Variabili

Un oggetto che mette insieme diversi set di valori in funzione delle varianti di prodotto. Il valore della variabile viene assegnato in produzione tramite opportuni filtri.

Nel progetto:

Filtri e metadati

Il meccanismo dei filtri permette di includere o escludere il contenuto nella produzione dei documenti. I filtri si basano su metadati impostati (per esempio il metadato Sales Region: Germania)

Layout specifico

Questo consente di assegnare diversi layout ai nostri nodi in fase di produzione.

Siete interessati al CCMS ST4 o ad una consulenza? Contattateci!

Share this post

Condividi su facebook
Condividi su twitter
Condividi su linkedin
Condividi su print
Condividi su email