La via dell'informazione 4.0

Il signor Maier è un redattore tecnico esperto in un'azienda meccanica di medie dimensioni. Nel corso degli anni l'azienda e anche i relativi prodotti sono stati ulteriormente sviluppati: le precedenti "soluzioni standard" non esistono più. Sono richieste soluzioni più complesse e nelle diverse varianti. La nuova politica aziendale si basa sul "flessibile ma veloce". A poco a poco il signor Maier aggiorna e crea nuovi manuali con l'aiuto del Copy & Paste.

Una delle nuove dinamiche e difficoltà che il signor Maier deve affrontare riguarda la necessità di produrre traduzioni in varie lingue poiché la versione tedesca e quella inglese non sono più sufficienti. Inoltre, i diversi standard devono essere osservati in base al paese a cui è destinata la traduzione.

Tutte le riscritture e gli adattamenti significano lavoro. Il signor Maier può farlo solo avvalendosi di un team competente.
Come se non bastasse i clienti sono più esigenti perché non si limitano più a chiedere istruzioni ma necessitano di servizi e prodotti personalizzati. I requisiti sono:

•   Layout con il logo aziendale dell'utente
•   Documenti di formazione
•   Formati multimediali
•   Help online
•    Istruzioni HTML.

Il signor Maier deve ottenere i documenti in diversi formati.

Nel frattempo, il signor Maier perde il controllo dell'intera situazione. Gli originali e le traduzioni sono disponibili in diversi formati. I costi di traduzione sono elevati e la conversione in formato digitale richiede molto tempo.

Il fine settimana si avvicina e il sole splende, ma le speranze di un week end tranquillo vengono meno quando all’improvviso uno dei clienti più importanti dell'azienda invia un rapporto nella giornata di venerdì nel tardo pomeriggio, manifestando lamentele per alcuni errori presenti nella documentazione tecnica. Dopo una breve discussione con i suoi colleghi, il signor Maier individua 10 paragrafi su un totale di 5 pagine che devono essere modificati nel documento campione inviato dal cliente. Questo è fatto in fretta! Il reparto vendite assicura al cliente che i documenti esistenti saranno disponibili sul portale aziendale entro lunedì mattina.

Ma non è possibile! Il signor Maier non è in grado di risalire ai documenti in cui è apparso per la prima volta questo errore. In quali formati, versioni, varianti, mercati è stato riutilizzato il documento difettoso? E anche se fosse in grado di correggere tutto, come gestirebbero la traduzione?

Il signor Maier lavora per tutto il fine settimana e nella ricerca di una soluzione permanente. C'è qualche software che potrebbe risolvere il problema?
Ma come si presenta una soluzione del genere? Lo scoprirete nella nostra serie di blog.

La parola chiave è “Informazioni 4.0”.

Modularizzazione 4.0

Errori incontrollati nella documentazione tecnica

Il signor Maier ha trascorso l'intero fine settimana a lavorare per correggere gli errori nella documentazione esistente di uno dei loro maggiori clienti. Hanno impiegato ore a rivedere la documentazione usando il copia e incolla. Lunedì mattina il signor Maier era ancora al lavoro e le traduzioni non erano ancora pronte. Il suo capo era tutt'altro che entusiasta. E questo ha aumentato ancora di più la frustrazione. Non trovando sul mercato alcun software di editing in grado di risolvere rapidamente la gestione delle modifiche, il signor Maier ha deciso di riflettere sul funzionamento della documentazione tecnica.

Contenuto di una singola fonte

Ha trovato così la soluzione: il problema è che per anni non aveva creato alcun contenuto originale di alta qualità. Quali cause di questa mancanza? Copia & Incolla e fattore tempo.

Spesso sono stati scritti nuovi contenuti invece di riutilizzarli, generando costi di traduzione non necessari e senza benefici nella qualità della documentazione. Questo significa inefficienza.

La soluzione si chiama Single Source Content: ogni contenuto originale esiste una volta sola e non viene duplicato, ma combinato con altri contenuti originali per creare documenti diversi.

È possibile farlo senza modificare il software?

Moduli e frammenti

Dopo alcuni tentativi si intuisce che il principio del Single Source Content è inevitabilmente combinato con la generazione di moduli di contenuto indipendenti che possono essere assemblati in modo flessibile.

Il primo problema pratico è la quantità di informazioni contenute in ogni modulo. Alcuni blocchi di informazioni molto lunghi (ad esempio alcuni capitoli standard) sono completamente riutilizzati e hanno diverse pagine.

Altri contenuti, invece, sono frammenti di testo che vengono ripetuti più volte nella documentazione tecnica. Tuttavia, il signor Maier nota direttamente che questo approccio non può essere implementato con il software attuale. Per creare moduli nel loro software, decide quindi di ridurre i moduli a una pagina. I frammenti purtroppo non sono possibili. Purtroppo, non tutti i moduli sono lunghi esattamente una pagina causando la creazione di alcune pagine mezze vuote. Il layout non è quindi molto facile da leggere.

Un puzzle

Il signor Maier vorrebbe andare oltre salvando e catalogando i moduli in cartelle.

Grazie alle nuove cartelle e sottocartelle, il signor Maier può ora trovare e riutilizzare i singoli moduli.

Ma la creazione e l'organizzazione dei moduli, che assomigliano a un puzzle, si sta rivelando più difficile del previsto. Nella parte successiva il signor Maier pensa a come integrare metadati e tassonomie nel suo sistema.

Il signor Maier vorrebbe avere ora una struttura di cartelle (link). Ora vuole definire i metadati. Queste sono le proprietà che compongono il modulo. Ci pensa. Attribuisce nomi chiari ai moduli, le cartelle ricevono anche i nomi. I nomi vanno dalla linea di prodotti al numero di articolo. Grazie a questi nomi, chiamati anche metadati, ora può facilmente compilare la sua documentazione.

Ma vuole allontanarsi dal vecchio sistema e automatizzare ancora di più. Per questo ha iniziato a cercare diversi sistemi e ora ha già diverse offerte. La maggior parte dei fornitori di software non ha dato un prezzo finale reale sostenendo che è necessario un caso d'uso per definire i requisiti.

Il signor Maier chiama il reparto marketing. Si mettono subito al lavoro. Analizzano i loro problemi utilizzando una tabella:

•   Molti testi generali in diversi manuali
•   Configurazioni di prodotto che hanno un impatto minore sul documento complessivo
•   Opzioni che il cliente può selezionare
•   Diversi formati - PDF ma anche Web
•   Correzione automatica dei nodi a fonte singola
•   Versione
•   Deviazioni dovute ai diversi mercati
•   Gestione delle traduzioni
•   Terminologia

Ma cosa significa tutto questo?

Il Sig. Maier cerca di rispondere a questo:

Domande	Risposte
Molti testi generali in diversi manuali	· Sì - finora sempre Copia e Incolla
Configurazioni di prodotto che hanno un impatto minore sul documento complessivo	· Sì, alla fine.
Opzioni che il cliente può selezionare	· Sì, abbiamo delle opzioni.
Diversi formati - PDF ma anche Web	· Al momento pubblichiamo tutto in PDF. · Altri formati sarebbero utili.
Correzione automatica dei nodi a fonte singola	· Un'unica fonte che abbiamo ora.
Versione	· Attualmente manuale
Deviazioni dovute ai diversi mercati	· Europa/America/Asia
Gestione delle traduzioni	· La nostra agenzia di traduzioni si occupa della traduzione. Non abbiamo una visione d'insieme dei costi.
Terminologia	· Abbiamo alcune liste

Inviano le loro risposte a tutti i fornitori di software. Un fornitore di software risponde prontamente e offre una prova gratuita.
Il signor Maier è soddisfatto. Risponde immediatamente e chiede una versione di prova. Mentre imposta la versione di prova sul suo computer, il signor Maier ottiene un'altra risposta con ulteriori domande e il suggerimento di una demo.

Domande	Risponde Markus F.	Fornitore di software
Molti testi generali in diversi manuali	Sì - finora sempre Copia e Incolla
Configurazioni di prodotto che hanno un impatto minore sul documento complessivo	Sì, alla fine.	· Da dove provengono i dati tecnici? Utilizzate un PLM nella vostra azienda? · Come vengono create le configurazioni dei vostri prodotti? C'è un configuratore?
Opzioni che il cliente può selezionare	Sì, abbiamo delle opzioni.	· Le opzioni sono opzioni standard? · Ogni opzione ha un testo standard?
Diversi formati - PDF ma anche Web	Al momento pubblichiamo tutto in PDF. Altri formati sarebbero utili.	· Quale software sta utilizzando attualmente? · Avete dei layout standard?
Correzione automatica dei nodi a fonte singola	Un'unica fonte che abbiamo ora.	Possibile attraverso il riutilizzo.
Versione	Attualmente manuale	· Avete un flusso di lavoro preciso?
Deviazioni dovute ai diversi mercati	Europa/America/Asia	· Differenze testuali? · Immagini?
Gestione delle traduzioni	La nostra agenzia di traduzioni si occupa della traduzione. Non abbiamo una visione d'insieme dei costi.	· In quali lingue traducete?
Terminologia	Abbiamo alcune liste.	· Volete un aiuto per l'authoring per una maggiore identità del marchio?

Sistema di test

Nel frattempo, il signor Maier ha organizzato tutto. Il sistema è collegato a MS Word e dispone di macro che creano automaticamente il documento in Word. Legge nei suoi nodi a poco a poco. Ora vuole creare metadati e tassonomie. Non c'è una vera e propria funzione per questo. Può rifare tutto da capo utilizzando solo la struttura delle cartelle e i nomi dei file.
Con l'aiuto di modelli può ora riutilizzare i suoi nodi e Word crea automaticamente il documento, ma questo lavoro necessita di molto tempo.

Ora sta leggendo le traduzioni. Funziona tutto piuttosto bene ma si necessita una rielaborazione in Word perché ogni lingua ha una lunghezza diversa.
Al momento ha davanti a sé un esempio di layout. Sta valutando se questo può essere creato anche in altri layout. Sarebbe fantastico, naturalmente! Decide allora di contattare il fornitore del software. La risposta arriva immediatamente:

"No, devono impegnarsi in un'impaginazione".
Naturalmente, il signor Maier lo limita di nuovo poiché non sempre vuole pubblicare solo in PDF.
Gli altri fornitori hanno parlato di argomenti diversi:

•    Filtro
•    Dita
•    iiRDS
•    Video nella documentazione tecnica
•    Integrazioni con altri sistemi
•    XML
•    Flusso di lavoro
•    Versione

Nel nostro prossimo blog il signor Maier cerca di migliorare la sua documentazione esistente con regole di scrittura e naturalmente sta ancora cercando il sistema giusto.

Guida editoriale 4.0

Il sistema di test funziona. Ma il signor Maier sta pensando: se importo i miei documenti in un CCMS, non solo in una struttura chiara ma secondo regole di scrittura, i fornitori non avevano parlato di un sistema di authoring assistance?

Le regole sono tutto!
Il signor Maier vorrebbe prima di tutto concentrarsi sulle regole grammaticali e stilistiche. Dopo una lunga ricerca trova la linea guida dell’Italiano Tecnico Semplificato della Com&Tec e le regole dell'inglese tecnico semplificato (STE). Compra entrambe le edizioni e le legge.

Nel caso dell'inglese tecnico semplificato, esiste un dizionario di base con parole consentite e proibite. Ci sono anche regole chiare per la scrittura:

•    Grammatica
•    Struttura
•    Lunghezza

I termini tecnici sono suddivisi in diverse categorie. "Terminologia", per così dire. Se il sig. Maier impara l'inglese tecnico semplificato, può scrivere la documentazione direttamente in inglese, se necessario.

Prende un testo tradotto e cerca di riscriverlo secondo le regole di STE. Ci vuole molto tempo, ma l'effetto prima e dopo è chiaramente visibile:

Prima:	Dopo:
Making Pizza	How to make pizza
First of all, preheat the oven to 400° Fahrenheit (204°Celsius): the oven should be piping hot before you start cooking the pizza.	Make pizza as follows: 1. Set the oven temperature to 400° Fahrenheit (204°Celsius). 2. Wait until the oven has a temperature of 400° Fahrenheit (204°Celsius).
In order to prepare the crust, first remove the unbaked crust from the packaging, then place it on a round or rectangular baking sheet, depending on what you have on hand. Use a pastry brush to spread a thin coating of olive oil over the top of the crust.	3. Prepare a circular or a rectangular baking sheet. 4. Open the packing of the unbaked crust. 5. Remove the unbaked crust from the packing. 6. Put the unbaked crust on the baking sheet. 7. Apply a thin layer of olive oil with a pastry brush on the crust.
Now you can spread pizza sauce on the crust. How much pizza sauce you add is purely a matter of personal preference: if you love a lot of sauce, go ahead and slather it on. On the other hand, if you prefer your pizza on the dry side, spoon a little in the middle and spread it around in a thin layer. But if you want to make a white pizza, add just a little extra olive oil and skip the pizza sauce.	8. Put a pan on the stove. 9. Open a can of diced tomatoes. 10. Put the diced tomatoes in the pan. Do not drain them. 11. Put tomato paste in the pan. 12. Add salt, oregano and pepper. 13. Set the stove to ON. 14. Boil the tomato sauce until it has the necessary consistency. 15. Set the stove to OFF. 16. Put the tomato sauce on the unbaked crust with a spoon. For a dry pizza, apply a thin layer of tomato sauce only. For a white pizza, do not put the tomato sauce on the pizza. Put more olive oil on the unbaked crust.

Come passo successivo, cerca di definire delle regole specifiche sue in forma di una guida di stile utilizzando le regole di STE e di ITS.

Guida di stile

Se l'operatore deve fare qualcosa, lo scrittore tecnico deve utilizzare l’imperativo. Allora è chiaro all'operatore che deve mettersi al lavoro.

E così via con le procedure:

•   Utilizzare l'elenco numerato
•   Utilizzare l'imperativo
•   Utilizzare la frase introduttiva prima della lista numerata
•   Spiegare il risultato dopo aver completato la lista numerata.

Titolo

I titoli devono essere brevi, esplicativi e strutturati in modo uniforme.
I titoli verbali sono facili da capire.

Esempio:

Male	Bene
Installazione driver	Installazione del driver
Come ho configurato il PC	Configurazione del PC

Ci sono diversi approcci nella linea guida TEKOM. È importante decidere un metodo e applicarlo in modo coerente.

Titoli e sottotitoli

Le ripetizioni inutili devono essere lasciate fuori dalla struttura del titolo. Altrimenti i titoli non sono di facile lettura e la struttura non è sempre chiara.

Male	Bene
1. Funzionamento della macchina	1 Funzionamento della macchina
1.1 Parametri di funzionamento della macchina	1.1 Impostazione dei parametri
1.2 Preparazione della macchina per il funzionamento	1.2 Preparazione della macchina

Titoli ben strutturati e organizzati aiutano l'operatore ad orientarsi nel manuale. Non bisogna mai perdere di vista questo. I titoli sono la struttura di base di un documento.

Pronomi

A differenza dei libri, non si dovrebbero usare i pronomi nella redazione tecnica. I pronomi possono dare vita a interpretazioni errate.

Male

Bene

L'uomo porta a spasso il cane. È vecchio.

DOMANDA:

Chi è vecchio? L'uomo o il cane?

L'uomo porta a spasso il cane. L'uomo è vecchio.

Ora è chiaro che si ci si riferisce l'uomo.

Preposizioni

I redattori tecnici spesso tralasciano le preposizioni. In questo modo la scrittura è più veloce e si risparmia spazio. Ma spesso al lettore mancano i riferimenti. Questo può essere fuorviante.

Male

Bene

Ruota freno a olio

DOMANDA:

L'olio è per la ruota o per il freno?

Olio per freno ruota

Ora è chiaro a cosa serve l'olio. Inoltre, il sostantivo composto aiuta a capire.

Passivo

Le frasi passive lasciano il dubbio su chi deve fare che cosa. Le frasi passive dovrebbero essere evitate nella redazione tecnica. L'operatore deve sapere cosa deve fare. Le possibilità di interpretazione devono essere escluse!

Male

Bene

La macchina deve essere spenta.

DOMANDA:

Chi spegne la macchina?

Spegnere la macchina.

L'imperativo indica al lettore di spegnere la macchina.

Stile di scrittura

Ma le liste numerate non sono veramente grammaticali. Come passo successivo, il signor Maier vorrebbe analizzare la struttura e la configurazione.

Frasi brevi
Le frasi “annidate” sono di solito incomprensibili. Il lettore deve leggere la frase più volte. Soprattutto in un testo descrittivo si dovrebbe prestare attenzione alla lunghezza del testo. Come regola generale si può impostare un massimo di 25 parole.

Male	Bene
La macchina è una macchina da stampa che può essere utilizzata solo da persone ben addestrate che hanno ricevuto una formazione in questo campo e che hanno almeno 5 anni di esperienza, al fine di evitare un errore grave di produzione o l’arresto durante la produzione.	La macchina da stampa può essere utilizzata solo da personale addestrato con 5 anni di esperienza professionale. In questo modo evitano errori durante la produzione e un arresto della produzione.

La struttura e la sequenza delle frasi devono essere logiche e corrispondere alla sequenza delle operazioni.

Elenchi
Sia le liste numerate sia quelle con i punti devono essere uniformi:

•    Le maiuscole e le minuscole devono essere definite.
•    La punteggiatura deve essere definita.
•    Le frasi non devono essere interrotte.

Male

Bene

L'operatore deve spegnere:

- la macchina

- L'elettricità;

- La Luce

L'operatore deve spegnere quanto segue:

- Macchina

- Elettricità

- Luce.

Nel nostro esempio abbiamo una frase introduttiva completa. Gli articoli sono stati omessi dalla lista per affrontare il problema dell’accusativo specialmente durante la fase della traduzione. Nell'elenco si raccomanda di iniziare sempre con la lettera maiuscola. Omettere il “punto e virgola” e terminare la lista con un punto.

Queste regole sono ovviamente solo suggerimenti. Tuttavia, lo scrittore tecnico deve scegliere una regola per rimanere coerente.

Stile

E in questo modo si può anche risparmiare sui costi di traduzione:

Male	Bene
Premere il tasto.	Premere il tasto.
Schiacciare il tasto.	Premere il tasto.
Premere il pulsante.	Premere il tasto.
Premere il pulsante verso il basso.	Premere il tasto.

Come in STE e in ITS signor Maier vorrebbe definire i termini tecnici.
Nella prossima sezione, il signor Maier sta ora cercando un sistema che combini la terminologia e le regole in un unico CCMS.