Migrazione della documentazione tecnica

23 Aprile 2021

Cosa intendiamo quando parliamo di migrazione della documentazione tecnica?  Se volessimo ridurla ai minimi termini, la migrazione non è altro che la conversione dei documenti da un formato all’altro. Ma, ovviamente, non è tutto qui.

Chi si occupa di documentazione tecnica sa bene che uno dei più grandi ostacoli al proprio lavoro è la filosofia del “si è sempre fatto così”. Manuali, norme, fogli illustrativi, cataloghi, vengono tramandati di generazione in generazione, aggiornamento dopo aggiornamento, finendo poi per creare documenti Frankenstein che perdono di efficacia.

Ecco perché la migrazione della documentazione tecnica diventa davvero efficace quando il formato di destinazione permette di strutturarla secondo dei parametri condivisi.

Migrare contenuti tecnici: i vantaggi

Analizzare un corpus di documentazione già esistente per convertirlo in nuovi formati ci dà la possibilità di verificare un’ampia gamma di criticità ereditate nel tempo, e di introdurre una serie di benefici. Un processo standard di migrazione ci permette per esempio di:

  • Individuare contenuti duplicati che possono essere ottimizzati;
  • Ottimizzare strutture obsolete, come cascate su cascate di sotto paragrafi;
  • Individuare collegamenti interni a sezioni eliminate;
  • Ridurre i costi di aggiornamento in fase di redazione;
  • Ridurre i costi di traduzione e impaginazione.

Un problema molto comune è quello di trovarsi a dover aggiornare delle piccole porzioni di testo, degli snippets, come ad esempio le avvertenze all’interno di un manuale. Con una migrazione strutturata è sufficiente modificare il testo in un unico punto perché le modifiche vengano recepite a cascata dove necessario.

Una migrazione dei contenuti efficiente

Se è vero che, come dicevamo in apertura, migrare la documentazione tecnica può voler dire anche solamente spostarla da un software all’altro, una migrazione intelligente prevede la conversione verso una gestione “topic based”, ossia per moduli.

Con una gestione topic based, invece di avere una corrispondenza 1:1 tra il documento originale e quello migrato, la nuova documentazione sarà divisa in unità più piccole, che potranno essere riutilizzate più agevolmente all’interno di un singolo manuale o di più manuali.

In Editha prediligiamo due soluzioni.

MadCap Flare

In quanto MadCap Advanced Developers abbiamo sviluppato un flusso di lavoro ad hoc per la migrazione di contenuti da formati legacy come Word, Frame Maker, PDF a MadCap Flare.

In quanto CMS per l’authoring per la gestione avanzata dei contenuti, MadCap Flare permette una strutturazione precisa dei contenuti secondo una filosofia topic based, con una gestione snella degli aggiornamenti e una ottima integrazione nei flussi di traduzione multilingua.

PTC Arbortext

Per soluzioni aziendali integrate, abbiamo strutturato un team di lavoro per la migrazione dei contenuti xml-based strutturati in CMS, con l’appoggio dell’editor PTC Arbortext. Abbiamo così migrato interi corpi di documentazione tecnica da formati come Word, PDF e FrameMaker a un formato di xml strutturati, organizzati tra loro in modo da poter essere condivisi in centinaia di documenti diversi.

Come migrare la propria documentazione tecnica

Il primo passo per iniziare un percorso di migrazione della documentazione tecnica è l’analisi dei contenuti esistenti, per poter valutare la qualità, la struttura e i software di partenza.

La scelta del software di destinazione, sia che si tratti di MadCap Flare, di Simosoft CMS con PTC Arbortext o altro, può dipendere sia da necessità interne e scelte aziendali, o dal formato di pubblicazione desiderato.

Con oltre 30 anni di esperienza nel settore della documentazione tecnica, possiamo essere il tuo partner perfetto per iniziare il percorso di migrazione dei tuoi contenuti. Contattaci e troveremo insieme la soluzione più adatta alla documentazione della tua azienda.

Scritto da Sabrina Fiorini

Sabrina Fiorini è la CEO e Project Coordinator di Editha. Con quasi 30 anni di esperienza nel campo del Desktop Publishing, ha fondato Editha creando una rete internazionale di professionisti del settore per offrire un'offerta completa ad agenzie di traduzione e dipartimenti di redazione tecnica. Ama l'apprendimento continuo ed è appassionata di diete che legge assiduamente sorseggiando un calice di buon vino rosso.
Documentazione tecnica e sostenibilità

Documentazione tecnica e sostenibilità

Tra i punti oggetto di discussione nella bozza del nuovo Regolamento Macchine troviamo anche la proposta, diretta al fabbricante, di realizzare l’intera documentazione che accompagna la macchina esclusivamente in formato digitale. È possibile avviarsi verso una digitalizzazione anche solo parziale della documentazione tecnica? È quello che i tecnici attualmente al lavoro sulla nuova proposta di Regolamento Macchine si stanno chiedendo. Questo articolo analizza criticità e vantaggi di questa digitalizzazione.

Articulate 360

Articulate 360

Articulate è una delle voci più note nel settore della formazione a distanza, e i suoi Storyline 360 e Rise 360 sono i programmi che in Editha abbiamo imparato ad apprezzare in anni di collaborazioni con agenzie di traduzione e clienti.

0 commenti

Invia un commento

Il tuo indirizzo email non sarà pubblicato.