xml_2

Standard di documentazione tecnica basati su XML – Parte 1

Il mondo della comunicazione tecnica negli ultimi 20 anni ha dovuto fronteggiare profondi cambiamenti riguardanti solo in parte il settore dell’ingegneria meccanica, poiché questi sono rimasti ancorati a sistemi tradizionali di redazione e di traduzione della documentazione tecnica.

Le ragioni per non aver apportato modifiche in questo settore non sono sicuramente da imputare ad una mancata lungimiranza: se i produttori tedeschi sono considerati all’avanguardia della tecnologia in campo internazionale è perché hanno saputo interpretare prima e meglio le esigenze di un settore produttivo sempre più competitivo ed esigente. Le vere ragioni sono da imputare proprio all’evoluzione continua e veloce della tecnologia e alla capacità di adattamento al mercato, che si traduce in una produzione e nell’ideazione di soluzioni chiave su misura per l’utilizzatore.

Pertanto, non è sfuggito a nessun ufficio tecnico che l’utilizzo di un sistema CMS permette di evitare di riscrivere gli stessi contenuti più volte, risparmiando così costi di traduzione attraverso l’utilizzo di un CAT-Tool. Quindi, una terminologia standardizzata e l’utilizzo di software ottimizzati per la redazione permettono di ottenere performance migliori dal punto di vista grafico / strutturale della documentazione. In realtà spesso quasi nessuno di questi miglioramenti è stato utilizzato.

Non solo sono le prestazioni di questi sistemi sono state insoddisfacenti a causa dell’impossibilità di standardizzazione tecnologica nel breve periodo, ma sono anche da considerare i costi di acquisto delle licenze di training del personale preposto alla supervisione della documentazione.
Il grande scoglio è stato quello di decidere quale insieme di sistemi adottare. Se la scelta del software di traduzione non è stata troppo difficile (SDL e Across da soli si dividono quasi tutto il mercato), in campo CMS e software di redazione la scelta è vastissima. E una volta presa una decisione una domanda sorge spontanea; come gestire la documentazione tecnica?

Fatte queste considerazioni, non c’è da sorprendersi se molti produttori, per redigere un nuovo manuale modificano quello di una macchina simile, effettuando cambiamenti fino all’ultimo minuto (a volte fino al giorno precedente al collaudo ufficiale) e contrassegnando i paragrafi da tradurre. Si inviano poi i documenti all’agenzia di traduzione scelta e saranno quindi necessarie pressioni per ottenere la traduzione nel più breve tempo possibile, pena la mancata accettazione della macchina da parte del cliente.

Questo sistema, da Tekom e da noi è considerato medievale, ma dai piccoli produttori di macchine (se non altro in ottica breve termine) l’unico possibile. Esso è destinato ad essere spazzato via dal nuovo standard XML.

DITA era uno standard che ha già modificato la documentazione tecnica, ma ora è considerato obsoleto in molti campi. Il nuovissimo standard iiRDS entra nell’area dell’Industria 4.0.

Iniziamo oggi con il formato precedente, che ha influenzato il montaggio tecnico. Cos’è DITA XML? È un nuovo standard di cui nessuno è proprietario, che può essere applicato a tutti i formati e non richiede software o licenze particolari. Con questo standard si separano i testi dalla grafica, dall’impaginazione e dalle traduzioni, il tutto in modo trasparente. Con DITA XML è possibile scrivere moduli intercambiabili con diversi utilizzi. Sarà possibile cambiare lo stile aziendale o selezionare il nuovo layout con un click. Come si può notare: XML – e non solo DITA – sono indipendenti dal layout e offrono quindi una grande flessibilità.

DITA si basa su argomenti che hanno una struttura chiara e coerente. Pertanto, questo standard ha anche dato forma a una nuova modalità di lavoro: DITA può essere considerato come stile guida e metodo di scrittura.

Gli argomenti sono suddivisi in:

  • Concetto
  • Task
  • Riferimenti

Ogni stile di argomento ha una composizione e diverse caratteristiche stilistiche. Pertanto, diversi scrittori tecnici possono lavorare secondo lo stesso principio di funzionamento.
I produttori di macchine dovranno semplicemente uno dei programmi software disponibili supportati da DITA. Così si potrà lasciare che i redattori tecnici scrivano internamente ed esternamente con gli stessi criteri. Come detto prima, non è solo uno standard, è un metodo di lavoro che è stato ed è la base per la progettazione funzionale e per la scrittura editoriale basata su argomenti o nodi.

DITA ha fortemente influenzato i redattori tecnici. Nuovi metodi sono stati sviluppati e utilizzati come base per i nuovi standard e le nuove tecnologie XML. Oggi non stiamo solo pubblicando le nostre informazioni nei sistemi di guida in linea. Oggi ci troviamo di fronte a una sfida: trasmettere i nostri contenuti anche sulle piattaforme digitali. Le macchine interagiscono sempre più con le persone ed è esattamente questo ciò di cui vogliamo parlare nel nostro prossimo blog.

Se siete interessati modularizzare la vostra documentazione tecnica contattateci mail info@because-italy.com

Share this post

Condividi su facebook
Condividi su twitter
Condividi su linkedin
Condividi su print
Condividi su email