Come adottare con successo un software CMS per realizzare manuali e documentazione tecnica
![]() Consigli per migrare i contenuti da una gestione "a mano", non strutturata (effettuata per esempio utilizzando MS Word), a una gestione strutturata, tramite software di Content ManagementIl modo in cui avviene la migrazione delle informazioni verso il software di gestione dei contenuti rappresenta un fattore determinante per il successo di un progetto di adozione di un sistema CMS. Nelle fasi iniziali dei progetti di adozione di Argo CMS, il nostro software per la realizzazione di manuali e documentazione tecnica, ci sentiamo rivolgere spesso la domanda, se Argo disponga di funzioni di importazione della documentazione pregressa. Al di là delle soluzioni tecniche possibili (Argo dispone di funzioni di importazione di testi in formato RTF, DOC e DOCX e di tabelle in formato XLS, ed è possibile lo sviluppo di funzioni di importazione a progetto), a questa domanda replichiamo con il quesito: "Sì, ma che cosa intendete importare in Argo?". Da una prima, rapida analisi emerge normalmente, che la documentazione pregressa - specie se gestita "a mano", in modo non strutturato - non esprime e non traduce in modo uguale concetti uguali: dal macro al micro, per ogni contenuto (sia esso, per esempio, una tavola di presentazione dei pittogrammi, un warning o l'etichetta del modello del macchinario) esistono spesso diverse versioni, stratificatesi nel tempo e che necessitano di essere anzitutto standardizzate prima della loro migrazione all'interno del software di gestione dei contenuti. Ma la standardizzazione non è tutto. StandardizzazioneStandardizzare i contenuti significa esprimere in modo uguale concetti uguali. UnivocitàPer rendere efficiente la redazione (editing) e la traduzione, ogni contenuto deve essere univoco, va gestito cioè una sola volta nel software di content management e riutilizzato laddove necessario. GranularitàUn punto di forza dei software di gestione dei contenuti sta nella loro capacità di agevolare il riutilizzo delle informazioni.
Mentre "a mano" è estremamente difficile gestire l'univocità, la granularizzazione e il riutilizzo dei contenuti, i software CMS mettono a disposizione del redattore tutte le funzioni necessarie a tenere facilmente sotto controllo questi aspetti. Standardizzazione, univocità e scelta del livello di granularità rappresentano le linee guida per "distillare" dalla manualistica e documentazione tecnica pregressa i contenuti da importare all'interno del software di content management. NormativeLa migrazione è l'occasione per verificare, se struttura, contenuti e forme di presentazione sono conformi alle normative vigenti (per esempio alla Direttiva Macchine 2006/42/CE) e per effettuare eventuali adeguamenti. Metodiche di techical writingLa migrazione è anche l'occasione per rivedere i contenuti applicando regole e standard della scrittura tecnica (technical writing), che hanno l'obiettivo di ridurre i costi di redazione, manutenzione e traduzione della documentazione, di garantirne qualità e conformità alle normative, nonché fruibilità ottimale da parte dei destinatari (per esempio gli installatori, operatori e manutentori di un macchinario). I software di gestione dei contenuti possono agevolare il redattore proponendo modelli (template) di manuali a norma, supportando la gestione della terminologia e di glossari personalizzati e fornendo funzioni di autocompilazione. Obiettivo comune a tutte le attività fin qui illustrate è di produrre contenuti "certificati", riutilizzabili all'interno di tutta la documentazione tecnica aziendale, comunicata a vari destinatari (per esempio: forza vendita, rivenditori, installatori, utilizzatori, manutentori, ecc.), attraverso vari canali (carta, web, mobile, app, cd/dvd, ecc.) e format editoriali (manuali, guide, certificazioni, schede, cataloghi, listini, ecc.). Riutilizzare i contenuti significa incrementare il rendimento dell'investimento necessario alla loro produzione. Per riutilizzare i contenuti è però necessario che il redattore riesca a trovare facilmente l'informazione cercata e a comprendere in quale ambito un determinato contenuto possa essere utilizzato (per ambito intendiamo, per esempio, qual è il suo destinatario, per quali format editoriali è stato concepito, attraverso quali canali può essere veicolato, ecc.). I sistemi di classificazione e di configurazione messi a disposizione dai software di content management rappresentano un aiuto prezioso in questo senso. Classificazione gerarchicaLa classificazione gerarchica rappresenta un primo strumento, che il redattore ha per reperire i contenuti da riutilizzare. Classificazione a faccette e marcaturaClassificazione a faccette e marcatura specificano l'ambito in cui un determinato contenuto (per esempio un intero capitolo, un singolo warning o una variabile) può essere utilizzato. Nel contesto della manualistica, dei cataloghi tecnici e della documentazione tecnica, la classificazione a faccette è essenziale per:
***
Condividete il link a questo post sui vostri social media: Share |
|