Quando sfogli un Manuale d’uso e avvertenze oppure altri tipi di Documentazione tecnica e commerciale, ti sei mai chiesto come avviene la loro produzione?

 
La progettazione e redazione di Documentazione tecnica può avvenire in diversi modi, anche se si possono ridurre a 2 quelli oggi maggiormente utilizzati:

 
1️⃣ la produzione e redazione tecnica stand-alone, i cui contenuti finiscono il loro tempo nel momento stesso in cui vengono realizzati, possono al massimo essere copiati/incollati (in molti casi vengono riscritti) e restano sparsi in base ai software usati per la loro produzione

2️⃣ la produzione e redazione tecnica collaborativa con contenuti strutturati (CCMS), i quali prendono vita e, attraverso una granulare catalogazione, vengono archiviati in un unico luogo in modo intelligente, potendo essere usati e riusati all’infinito anche da diverse aree aziendali.

 
Sebbene ci siano dei punti in comune tra i due metodi, ciò che li differenzia in larga misura è la gestione dei contenuti, non solo in termini di efficienza ma anche di ottimizzazione:

se nel caso 1️⃣ infatti vi è da un lato il grosso vantaggio di un’elevata personalizzazione e flessibilità nello scrivere testi e contenuti creati esclusivamente per quella specifica descrizione o procedura, ma al contempo lo svantaggio di lasciare fine a sé stesso ciò che si è realizzato, nel caso 2️⃣ si ha pari possibilità di personalizzazione con in aggiunta una gestione dei contenuti decisamente più smart, attraverso anche la loro progettazione nell’ottica della riutilizzazione per successive necessità.

Quindi, scegliere di adottare un metodo oppure l’altro dipende da vari parametri aziendali e di prodotto, che devono essere valutati di volta in volta.

 


 

IL SOFTWARE CCMS

Con l’acronimo CCMS (Component Content Management System) si fa riferimento ad un software dedicato alla gestione profonda e intelligente dei contenuti.

Adottare un CCMS nei processi di redazione di Documentazione tecnica permette di fornire univocità e modularità alla produzione di questi tipi di documenti. Ne esistono di diverse tipologie, ma i CCMS utili alla creazione di Documentazione tecnica devono avere necessariamente queste caratteristiche di base:

a) la gestione di un magazzino delle informazioni (Information Warehouse)

i blocchi di informazioni, definiti anche Cluster, non sono più soltanto fini a sé stessi e al momento in cui sono stati prodotti, ma vengono archiviati in un database di contenuti ben organizzato come se si trattasse di merce reale.

???? Così facendo è possibile collocare i contenuti in modo coerente e in un unico luogo, accessibile da più funzioni aziendali.

b) la gestione strutturata dei contenuti

grazie ad un modello XML vengono aggiunte maggiori informazioni al semplice dato (Tag, Meta dati) che permettono di catalogare il contenuto a vari livelli, andando anche nel dettaglio di concetti e argomenti.

???? Così facendo è possibile creare Smart Documents ottimizzando la creazione, traduzione, archiviazione e ricerca di Documentazione tecnica

 
Usare un CCMS con queste caratteristiche consente di ottimizzare i contenuti

◼ dando coerenza ai documenti prodotti

◼ ottimizzando i tempi di redazione grazie al richiamo di contenuti già inseriti e catalogati con profondità di dettaglio.

 

 

I TIPI DI CONTENUTI GESTIBILI DA UN CCMS

Il testo fa certamente da padrone, ma anche immagini, fogli di lavoro, links e documenti cartacei scansionati possono essere gestiti da un software CCMS dotato di capacità DMS (Document Management System) di gestione dei documenti.

Grazie a questa funzionalità è possibile:

◼ aggiungere intelligenza a documenti destrutturati, che resterebbero altrimenti di poca utilità

◼ gestire e controllare le versioni dei documenti, dalla loro creazione fino a quello corrente, anche in termini di autori

◼ aggiungere note e tag ai documenti.

 
Per la redazione di Documentazione tecnica l’uso di un CCMS è certamente utile per gestire tutti i contenuti necessari, come ad esempio:

???? descrizioni e caratteristiche di prodotto

???? descrizioni di procedure e sequenze

???? specifiche tecniche

???? procedure per l‘installazione e per la manutenzione

???? avvertenze di sicurezza

???? simboli e norme

???? immagini, disegni, grafici, video

e tanto altro ancora.

???? Attraverso un CCMS è possibile pubblicare contenuti sia per l’uso in formato cartaceo che per quello in formato digitale.

 


 

I VANTAGGI DI UN SOFTWARE CCMS

Introdurre l’uso di un software CCMS viene considerato come un’innovazione di processo nella produzione di Documentazione Tecnica. Non a caso infatti il focus non è soltanto sui contenuti che vengono prodotti, ma anche sul processo di gestione delle informazioni decisamente più ottimale e smart:

 

1. Gestione centralizzata e univoca dei contenuti

i contenuti vengono creati una sola volta, catalogati nel dettaglio, archiviati in modo coerente e omogeneo, e aggregati in un unico luogo in cui è possibile cercare e trovare ciò di cui si necessita (con ben identificato autore e revisore). Quindi non più dispersione delle informazioni in tanti software difficilmente integrabili tra loro, ma un unico software in cui creare, gestire e distribuire i contenuti

2. Ricerca efficiente ed efficace dei contenuti

grazie all’integrazione di informazioni solo documentali con informazioni strutturate, i dati di prodotto possono essere ricercati e trovati con estrema facilità, in tempi rapidi e in modo personalizzato a seconda delle proprie esigenze

3. Beneficio per molteplici aree aziendali

dall’Ufficio Tecnico che crea le informazioni, agli Uffici Produzione\Service\Marketing che necessitano di cercarle, fino agli Uffici Marketing\Documentazione tecnica che le distribuiscono, la maggior parte delle funzioni aziendali legate al prodotto può accedere ad un’unica piattaforma

4. Ottimizzazione delle traduzioni

Alimentando in modo costante il database dei contenuti con le relative traduzioni si tiene sotto controllo la gestione delle stesse, così da poter mandare in traduzione non più un intero documento ma soltanto le parti di cui non si dispone ancora della traduzione. Questo è possibile grazie al fatto che i dati, essendo strutturati, diventano maggiormente riutilizzabili e portano con sé tutto ciò che li riguarda, relativa traduzione compresa.

FREE EDIT CHE CCMS USA?

Noi abbiamo scelto il software EKR Orchestra che non è solo un CCMS, ma una vera e propria piattaforma modulare che ci consente di gestire la redazione di Documentazione tecnica in modo efficace ed efficiente, adeguandola alle nostre esigenze.

Grazie all’introduzione di EKR Orchestra nei nostri processi di redazione tecnica, abbiamo raggiunto i seguenti obiettivi:

 
????  riduzione dei tempi di creazione dei contenuti

???? archiviazione univoca dei contenuti

???? recuperabilità fruibile dei contenuti esistenti

???? ricerca di contenuti già redatti

???? strutturazione dei dati

???? ottimizzazione dei contenuti, relative traduzioni e immagini

???? diminuzione della possibilità di errore

???? standardizzazione dei contenuti, che sono così corretti e coordinati

???? archiviazione su database condiviso, utilizzabile anche da altre Business Unit

???? passaggio da una gestione statica dei contenuti ad una gestione dinamica

???? passaggio da una visione verticale del singolo operatore ad una visione orizzontale e trasversale a tutti gli operatori sui contenuti realizzati da Free Edit

???? agevolazione dell’interazione e della collaborazione tra diversi reparti aziendali.

 
 

Vuoi saperne di più su come si progetta la DOCUMENTAZIONE TECNICA di un prodotto, o come i nostri metodi possono OTTIMIZZARE I TUOI PROCESSI di redazione?

Contattaci!

Ph: Pixabay.com