Documentazione tecnica modulare

Benefici ottenibili con un approccio innovativo

Introduzione di un nuovo modello di gestione della documentazione tecnica

CONTESTO

  • azienda di medie dimensioni che opera a livello internazionale su commessa.
  • Ampia gamma di prodotti soggetti ad aggiornamenti e personalizzazioni
  • La documentazione soggetta a costanti aggiornamenti per seguire l’evoluzione delle macchine e le personalizzazioni.
  • I La documentazione è sviluppata in Word da diversi manualisti e successivamente tradotta. Ogni manuale componente la documentazione è sviluppato partendo da un manuale precedente.

CRITICITA’

  • Diversi manualisti possono lavorare contemporaneamente sulla stessa tipologia di manuale per due commesse differenti con conseguenti disallineamenti nei contenuti.
  • Alcune innovazioni si estendono a diversi prodotti, ma il più delle volte sono aggiornati solamente i manuali inerenti la commessa in lavorazione rimandando l’aggiornamento degli altri manuali a tempi futuri, salvo poi dimenticarsene con conseguenti disallineamenti tra i diversi manuali.
  • Le problematiche si aggravano nel caso di manuali da tradurre in quanto lo sviluppo della documentazione di commessa non parte dalla documentazione sviluppata più recentemente, ma dalla documentazione precedentemente sviluppata in lingua
  • Difficoltà nel tracciare le revisione dei manuali

OBIETTIVO

Identificare un nuovo approccio di gestione della documentazione che consenta una migliore qualità di contenuti e tracciabilità delle versioni e al contempo riduca i costi di traduzione.

ATTIVITA

  • Colloqui approfonditi con i clienti e con manualisti per inquadrare con precisione le aspettative e le problematiche riscontrate.
  • Individuato un approccio innovativo con sviluppo di manuali “modulari”.
  • Analisi del mercato e identificazione di un partner che proponesse delle soluzioni software in linea con la soluzione individuata
  • Implementazione del nuovo software e formazione di un manualista al nuovo approccio
  • Realizzazione di alcuni manuali “pilota” e messa a punto del nuovo software per renderlo pienamente operativo e fruibile
  • Definizione del piano di migrazione dal vecchio al nuovo sistema
  • Attuazione del piano e contestuale formazione dei rimanenti manualisti

RISULTATO

  • Il progetto ha portato alla realizzazione di una famiglia di manuali completamente nuova che ha risolto le precedenti problematiche raggiungendo gli obiettivi prefissati.
    Va evidenziato che lo sviluppo di documentazione di tipo modulare fornisce i maggiori benefici nelle realtà in cui vi sia un’ampia gamma di prodotti complessi soggetti a continua evoluzione e che debbano essere tradotti in numerose lingue.
Condividi: