631915-PO9CVH-215

Roadmap: Redazione di documentazione tecnica 4.0

Dopo il grande successo delle stelle natalizie alla cannella, Gianni e Marco hanno capito che l’utilizzo di una guida porta a una buona redazione della documentazione tecnica.

Le regole sono importanti per la redazione!

Marco suggerisce di concentrarsi in primo luogo sulle regole grammaticali e stilistiche. E, dopo una lunga ricerca, trova diverse guide sull’italiano tecnico semplificato e sul simplified technical english. Acquista alcune di queste guide e comincia a leggerle.

Simplified Technical English

Nel caso del simplified technical english, esiste un dizionario di base contenente parole consentite e proibite. Inoltre, sono presenti chiare regole di scrittura:

  • Grammaticali
  • Strutturali
  • Di lunghezza dei testi

I termini tecnici sono suddivisi in diverse categorie.

“Come se fossero glossari terminologici” precisa Marco. Quindi, prende un testo tradotto e prova a riscriverlo. Ci vuole un po’ più di tempo, ma la differenza tra 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.

“Pensi solo al cibo!” ridacchia Sabrina, poi aggiunge: “Ma a cosa serve una guida in inglese? Scriviamo i manuali in italiano”.

“Posso tradurre le istruzioni in italiano” riflette Marco e si rimette al lavoro.

Style guide

Imperativo e infinito

Quando l’operatore deve fare qualcosa, il redattore tecnico deve utilizzare l’imperativo o eventualmente l’infinito per chiarire l’azione da svolgere. Così all’operatore è chiaro che dovrà mettersi all’opera.

Perciò, per la scrittura delle procedure:

  • Utilizza elenchi numerati.
  • Utilizza l’imperativo o l’infinito.
  • Scrivi una piccola introduzione prima di utilizzare l’elenco numerato.
  • Dopo l’elenco numerato scrivi le considerazioni finali.

Sabrina sghignazza: “E’ come un panino! E stiamo di nuovo parlando di cibo. Guardate! Ho trovato un esempio.”

Titolo

I titoli devono essere brevi, esplicativi e strutturati in modo uniforme.
I titoli contenenti un verbo sono facili da comprendere.

Esempio.

Errato

Corretto

Installazione di un driver

Installare un driver

Come ho configurato il PC

Come configurare il PC

Nell’italiano tecnico semplificato sono presenti diversi approcci. È importante scegliere un metodo e applicarlo in modo coerente.

Titolo e sottotitoli

Le ripetizioni non necessarie devono essere omesse dalla struttura del titolo. Altrimenti, i titoli non saranno di facile lettura e la struttura non sarà sempre chiara.

Errato

Corretto

1. Il funzionamento della macchina

1 Azionare la macchina

1.1. Parametri di funzionamento della macchina

1.1. Impostare i parametri

1.2. Preparazione della macchina per il funzionamento

1.2 Preparare l’avvio della macchina

Titoli ben strutturati e organizzati aiutano l’operatore a orientarsi con il manuale. Non bisogna mai perderlo di vista. I titoli sono la base di un documento.

Pronomi

Contrariamente alla scrittura dei libri, non si dovrebbero utilizzare pronomi nella scrittura tecnica. Questo perché i pronomi possono portare a fraintendimenti.

Errato

Corretto

Un uomo sta portando a spasso il cane. Lui è anziano.

DOMANDA:

Chi è anziano? L’uomo o il cane?

Un uomo sta portando a spasso il cane. Quell’uomo è anziano.

Ora è chiaro che l’anziano è l’uomo.

Preposizioni

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

Errato

Corretto

Ruota freno a olio

DOMANDA:

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

Olio per il freno della ruota

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

Forma passiva

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

Errato

Corretto

La macchina deve essere spenta.

DOMANDA:

Chi deve spegnere la macchina?

Spegni la macchina.

L’imperativo consiglia al lettore di spegnere la macchina.

Stile di scrittura

“Abbiamo già parlato di elenchi numerati. Non è proprio grammatica.” osserva Marco. “Sabrina, analizziamo la struttura e lo stile di scrittura”.

Frasi brevi

Le frasi disordinate sono spesso incomprensibili. Il lettore deve leggere la frase più volte per capire. In particolare, in un testo descrittivo si dovrebbe prestare attenzione alla lunghezza del testo. Come regola generale si può impostare un massimo di 20-25 parole a frase.

Errato

Corretto

Il macchinario in questione è una macchina da stampa che può essere azionata solo da persone molto ben istruite in questo settore e che abbiano almeno 5 anni di esperienza di lavoro con la macchina, al fine di evitare una produzione incorretta o addirittura fermi.

La macchina da stampa può essere utilizzata solo da personale specializzato e con 5 anni di esperienza professionale. In questo modo si evitano errori in fase di produzione e fermi.

La struttura delle frasi deve essere logica e la sequenza deve corrispondere a quella delle operazioni.

Elenchi

Sia gli elenchi numerati che quelli puntati devono essere uniformi:

  • È necessario utilizzare lettere maiuscole o minuscole in modo unificato.
  • La punteggiatura deve essere definita.
  • Le frasi non devono essere interrotte.

Errato

Corretto

L’operatore deve:

–          Spegnere la macchina,

–          l’elettricità,

–          E la luce.

L’operatore deve spegnere quanto segue:

–          Macchina

–          Elettricità

–          Luce

Nel nostro esempio abbiamo una frase introduttiva completa. Gli articoli sono stati omessi dall’elenco per evitare fraintendimenti. Si consiglia di iniziare sempre un elenco con la lettera maiuscola. È preferibile mettere un punto e virgola alla fine della descrizione di ogni punto e mettere un punto alla fine dell’elenco.

Ovviamente queste regole sono solo suggerimenti. Tuttavia, tocca al redattore tecnico scegliere le regole di scrittura, in modo da essere sempre coerente.

Stile

“Ho notato che paghiamo sempre per la traduzione della stessa frase. Perché?” chiede Sabrina.
“Non abbiamo uno stile uniforme e continuiamo a dire la stessa cosa con parole diverse.” nota Marco.

Errato

Corretto

Premere il pulsante.

Premere il pulsante.

Schiacciare il tasto.

Premere il pulsante.

Pigiare il tasto.

Premere il pulsante.

Premere il pulsante in basso.

Premere il pulsante.

“Quindi, non dovremmo registrare nel nostro database terminologico solo i termini tecnici, ma anche termini più generici” osserva Sabrina. Marco annuisce, concorda con lei.

In questo episodio Marco e Sabrina hanno iniziato a stilare una style guide per l’utilizzo dei termini nel loro sistema redazionale, così da facilitare la lettura dei testi da loro scritti.

Nel prossimo episodio, Sabrina presenterà una proposta per la gestione della terminologia e Marco troverà un sistema che combina la terminologia e la redazione tecnica in un CCMS.

E così si inizierà a lavorare in modo efficiente e risparmiando.

Per maggiori informazioni consulta il nostro servizio: bemodular

Se stai cercando un sistema che aiuti l’editor a utilizzare le regole di scrittura, contatta il nostro partner: www.congree.com

 

Share this post

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