Due approcci alla gestione di documenti e contenuti

Nell’ambito della produzione di manuali di istruzioni e documentazione tecnica in genere il redattore può seguire due diversi approcci:

1. Approccio top-down, dal generale al particolare
2. Approccio bottom-up, dal particolare al generale.

Approccio top-down: definizione e campo di applicazione

L’approccio top-down prevede la realizzazione di varianti di un documento mastro.

Le varianti si basano sulla struttura e sui contenuti del documento mastro, che viene variantato in base a uno o più parametri, per esempio: lingua, modello della macchina, gruppo di componenti (configurazione), mercato di destinazione, destinatario della comunicazione (es. installatore, operatore, manutentore, ecc.), evento (es. segnalazione degli accessori “novità dell’anno”, ecc.).

Si tratta dunque di un approccio che procede dal generale (il documento mastro) al particolare (le varianti) e che prevede la gestione dei contenuti a livello del singolo documento mastro.

Il metodo di variantatura top-down è applicabile in particolare alla gestione delle parti specifiche (parti tipiche) contenute nella documentazione tecnica relativa a:

• Macchine standard, disponibili in un numero predefinito di modelli o configurazioni standardizzate. Le varianti al documento mastro possono essere relative soprattutto al modello, alla configurazione, alla lingua, al mercato, al destinatario
• Macchine realizzate a progetto in assenza di componenti standard. Le varianti al documento mastro possono essere relative in particolare al destinatario.

Approccio bottom-up: definizione e campo di applicazione

L’approccio bottom-up prevede la gestione strutturata di frammenti di contenuto (componenti di base), che il redattore amministra in modo univoco e riutilizza un numero indefinito di volte per assemblare i singoli documenti specifici.

L’approccio bottom-up si differenzia da quello top-down, perché:

• La gestione dei contenuti non avviene a livello di documento, ma di frammenti di contenuto, cioè di singoli testi, immagini, tabelle o di insiemi di essi

• Non esiste un documento mastro, poiché i frammenti di contenuto sono utilizzati dal redattore come componenti di base per assemblare di volta in volta un documento tecnico già specializzato a valle in base a determinati parametri (modello o configurazione della macchina, lingua, mercato, destinatario, ecc.).

L’approccio bottom-up procede dunque dal particolare (i frammenti di contenuto) al generale (il documento).

Il metodo di assemblaggio bottom-up è applicabile in particolare alla gestione di:

• Parti comuni (es. premesse, informazioni generali, note sulla sicurezza e sull'installazione, ecc.) applicabili a tutte le macchine o a loro insiemi omogenei
• Macchine realizzate a progetto in presenza di componenti standard, che possono essere descritti da frammenti di contenuto (componenti di base) standardizzati e dunque riutilizzabili.

Top-down o bottom-up? E’ anche una questione di tecnologia

In termini pragmatici, la scelta se adottare l’approccio top-down o bottom-up è condizionata anche dagli strumenti tecnologici di cui dispone il redattore:

• La variantatura di un documento mastro (in base a lingua, mercato, modello o configurazione) è onerosa, ma praticabile anche quando il redattore gestisce la documentazione tecnica “a mano”, utilizzando cioè MS Word o software di impaginazione manuale (es. MS Publisher, Adobe PageMaker, InDesign, ecc.)
• La gestione di frammenti di contenuto e il loro assemblaggio, così come l’applicazione di parametri di variantatura più raffinati (es. destinatari, auto-configurazione del documento in base ai codici della distinta base, ecc.), sono possibili solo utilizzando strumenti di Content Management (CMS), che permettono una gestione strutturata dei contenuti e assistono il redattore con funzionalità specifiche di marcatura, ricerca e selezione, configurazione, composizione e impaginazione automatiche del documento.

CMS e integrazione fra approccio top-down e bottom-up

Dal momento che l’approccio top-down e quello bottom-up hanno campi di applicazione specifici, è compito dei sistemi di Content Management (CMS) supportare entrambe le metodiche, permettendo al redattore di scegliere in base al contesto se variantare un documento mastro, assemblare un documento specifico a partire da frammenti di contenuto (componenti di base) o combinare le due modalità operative.

Argo CMS

A partire dalla versione 2.2.0.0 (gennaio 2011), Argo CMS – il sistema di Content Management di KEA s.r.l. – supporta appieno l’approccio top-down, quello bottom-up e l’integrazione fra i due.

Strumenti di Argo CMS a supporto dell’approccio top-down

Gli strumenti che Argo CMS mette a disposizione del redattore per variantare un documento mastro attengono ai seguenti ambiti:

• Gestione delle revisioni del documento
• Marcatura dei contenuti del documento
• Auto-configurazione e auto-composizione del documento
• Impaginazione automatica del documento.

Sia pure in modo non primario, lo strumento di gestione delle revisioni supporta l’approccio top-down, permettendo al redattore di far seguire al documento il ciclo di vita della macchina o di partire da un manuale esistente per realizzare la documentazione di una nuova macchina analoga a quella già descritta.

Le funzioni di marcatura dei contenuti rivestono invece un ruolo fondamentale, poiché consentono al redattore di parametrizzare i contenuti, automatizzano quindi la configurazione e composizione del documento.

Argo CMS supporta la marcatura in tre ambiti operativi fra loro integrati:

• Gestione delle proprietà atte a marcare i contenuti
• Marcatura dei contenuti
• Selezione dei contenuti marcati.

Anzitutto il redattore gestisce le proprietà atte a marcare i contenuti presenti all’interno del documento mastro. A titolo esemplificativo, le proprietà possono essere relative ai seguenti ambiti:

• Destinatario
  • Le direttive in materia di redazione della documentazione tecnica suggeriscono di realizzare varianti del documento mastro in base al destinatario della comunicazione (es. installatore, operatore, manutentore, ecc.). In Argo CMS il redattore può definire i destinatari e marcare i contenuti come relativi a uno, a più o a tutti i destinatari
• Modello o configurazione della macchina
  • Il redattore può definire a mano modelli e configurazioni della macchina oppure importare in automatico codici della distinta base (BOM - Bill of Material), utilizzando successivamente questi dati per marcare i contenuti come relativi a uno, a più o a tutti i modelli (o configurazioni) della macchina
• Mercato
  • Il redattore può definire i mercati di destinazione della macchina (es. "Mercato USA", il "Mercato europeo", ecc.) e marcare i contenuti come relativi a uno, a più o a tutti i mercati
• Evento
  • In particolare nell’ambito della cataloghistica tecnica (cataloghi ricambi, cataloghi prodotto) il redattore può definire eventi (es. "Novità", "Fiera ABC", ecc.) e marcare i contenuti come relativi a uno, a più o a tutti gli eventi
• Lingua
• Altri...

Per realizzare la variante del documento mastro, il redattore definisce uno o più criteri di selezione automatica dei contenuti (es. solo i contenuti relativi al destinatario “Installatore” e al modello “01” della macchina ABC), ottenendo l’auto-configurazione del documento.

Le funzioni di auto-composizione si integrano con quelle di auto-composizione del documento: Argo CMS è infatti integrato con applicazioni di impaginazione automatica di manuali, documentazione tecnica, cataloghi prodotto e cataloghi ricambi in formato MS Word (per i documenti più semplici), Adobe FrameMaker e InDesign.

Strumenti di Argo CMS a supporto dell’approccio bottom-up

Gli strumenti che Argo CMS mette a disposizione del redattore per la gestione di frammenti di contenuto e il loro assemblaggio all’interno di documenti specifici attengono ai seguenti ambiti:

• Gestione dei contenuti
• Marcatura dei contenuti
• Selezione dei contenuti
• Assemblaggio del documento specifico.

In Argo CMS il redattore può allestire uno o più archivi “globali” di frammenti di contenuto (componenti di base) da riutilizzare per assemblare documenti specifici.

L’archivio “globale” può contenere qualsiasi tipo di contenuto gestibile in Argo CMS:

• Contenuti singoli (es. testi, immagini, tabelle, testi corredati da pittogrammi predefiniti, ecc.)
• Insiemi di contenuti (es. sequenze composte da testi, immagini, tabelle, ecc.)
• Contenuti in-line (InLine) utilizzabili nel flusso del testo. A titolo esemplificativo, gli in-line permettono di standardizzare nomenclature (es. nomi di modelli di macchina, ecc.), espressioni tratte dalla terminologia aziendale e dati variabili in genere (es. matricole della macchina, numero di telefono del servizio di assistenza tecnica, ecc.), nonché di inserire immagini nel flusso del testo.

I contenuti dell’archivio “globale” possono essere soggetti a traduzioni e versioni.
Anche nell’archivio “globale” il redattore può definire proprietà e marcare i frammenti di contenuto per agevolare le operazioni di selezione dei componenti di base con i quali assemblare il documento specifico.

La versione corrente di Argo CMS permette al redattore di selezionare a mano i frammenti di contenuto e di assemblare a mano il documento specifico con semplici drag&drop dei componenti di base.

Due le modalità di assemblaggio dei frammenti:

1. Riferimento (Link): i componenti mantengono il collegamento con il contenuto presente nell'archivio "globale", riportando in automatico modifiche e traduzioni
2. Copia: i componenti non mantengono il collegamento con il contenuto dell'archivio "globale". Il redattore li può utilizzare come “base” su cui effettuare modifiche all’interno del documento in cui sono stati copiati.

Per accrescere l’efficacia dell’archivio “globale” KEA ha già allo studio funzioni di selezione automatica dei contenuti in base a uno o più parametri definiti dal redattore e di auto-configurazione (auto-composizione) del documento specifico a partire dai frammenti selezionati.

Anche in questa modalità di utilizzo, Argo CMS è in grado di impaginare in automatico i documenti assemblati.

Argo CMS supporta l’integrazione fra approccio top-down e bottom-up

Argo CMS permette al redattore non solo di scegliere in base al contesto se variantare un documento mastro o assemblare un documento specifico a partire da frammenti di contenuto (componenti di base), ma anche di combinare le due modalità operative.

Ogni documento può infatti essere composto sia da contenuti specifici gestiti all’interno del documento stesso, sia da contenuti comuni provenienti dall’archivio “globale”.

Obiettivo raggiungibile: miglioramento dell’efficienza

Sfruttando il supporto di Argo CMS all’integrazione fra approccio top-down e bottom-up è possibile migliorare sensibilmente l’efficienza del flusso di produzione di manuali di istruzioni e documentazione tecnica in genere.

In particolare è possibile:

• Ridurre tempi e costi di:
  • Redazione:
    • Gestione della variantatura e gestione di frammenti di contenuto (componenti di base) riutilizzabili comportano una standardizzazione dei contenuti e una semplificazione delle attività redazionali
  • Revisione:
    • La gestione univoca dei contenuti incrementa la loro manutenibilità
  • Traduzione:
    • Gestione univoca dei contenuti, tracciabilità dello stato di avanzamento delle traduzioni e utilizzo di memorie di traduzione permettono di ottimizzare l’attività del traduttore e di elevare la qualità delle traduzioni
  • Pubblicazione del documento:
    • Auto-configurazione delle varianti in base a criteri stabiliti dal redattore, assemblaggio con dra&drop di documenti specifici, automazione delle procedure di impaginazione e formattazione del documento semplificano il processo di pubblicazione di manuali, documentazione tecnica e cataloghi
• Ridurre il margine di errore
  • Il miglioramento della manutenibilità dei contenuti, nonché l’automazione delle procedure di selezione dei contenuti da pubblicare e di impaginazione del documento contribuiscono a ridurre il margine di errore
• Aumentare la coerenza
  • Il riutilizzo di contenuti multilingua standardizzati e l’automazione delle procedure di impaginazione innalzano il livello di coerenza strutturale, contenutistica e formale (grafica) del documento
• Realizzare documenti multi-canale (carta, web, ecc.)
  • Il fatto che i contenuti siano disponibili in forma strutturata, ne permette la pubblicazione multi-canale (Cross Media Publishing): su carta - mediante procedure di impaginazione automatica - e su internet, mediante l'integrazione con applicazioni web che permettono di gestire in modo automatico e dinamico la pubblicazione di manuali e documentazione tecnica in genere, nonché di cataloghi prodotto e cataloghi ricambi, dotati eventualmente anche di funzioni di e-commerce.

 

Autore: Petra Dal Santo