Regole e suggerimenti per redigere un buon manuale tecnico

Descrizione

Le Direttive ci indicano gli argomenti che devono essere trattati nel manuale. Aziende che usano le sole Direttive per redigere manuali si trovano a scontrarsi con una realtà più cruda: il manuale è inutilizzabile anche se tratta tutti gli argomenti richiesti dalle direttive.

Le chiamate all’assistenza tecnica aumentano, le associazioni dei consumatori alzano il cartellino giallo, nessuno usa il manuale. La sua manutenzione è difficoltosa e occorre scendere sempre a compromessi con lo strumento di redazione, i tempi di aggiornamento e i costi di traduzione sono fuori controllo.

Quali sono le cause? Perché manuali apparentemente dichiarati conformi sono giudicati all’estero illeggibili?
Quali sono le aspettative degli utenti all’estero? Quali sono i reali motivi di un incremento dei costi? Come la digitalizzazione e la industry 4.0 metteranno in crisi gli attuali processi di redazione? Cosa vuol dire “comunicazione tecnica” e quali sono le competenze richieste a un comunicatore tecnico?

Il seminario, organizzato in collaborazione con Writec, azienda aderente al Network Fornitori Accreditati, ha lo scopo di approfondire le basi della comunicazione tecnica relativamente alla progettazione e redazione di manuali di istruzione.

Obiettivi

Saper valutare la qualità di un manuale
Saper capire come è fatto un buon manuale
Riconoscere possibili errori o problemi con le istruzioni per l’uso
Capire cosa c’è dietro la progettazione di istruzioni per l’uso
Capire il tipo di informazioni che si aspetta l’utente
Confrontare i propri processi con quelli standard

Contenuti che verranno approfonditi nel corso dell’incontro:

Il manuale di istruzioni come parte dell’informazione che circonda l’utente
Elementi di valore delle istruzioni per l’uso: sicurezza, copertura argomenti, organizzazione, testi, illustrazioni, formati e distribuzione
Organizzazione di un manuale per una macchina
Organizzazione di un manuale per apparecchi elettronici
Organizzazione di un manuale per applicativi software
Panoramica normativa
Processi di traduzione e strumenti software a supporto
Processi di redazione e strumenti software a supporto

Destinatari

Responsabili della documentazione tecnica, redattori tecnici in ambito meccanico, elettronica e software.

Relatore

Vilma Zamboli: Information Mapping Certified Instructor e MadCap Flare Advanced Developer si dedica alla Comunicazione Tecnica dal 1999 dopo 15 anni come progettista software in ambito automazione industriale. CEO di Writec, ha formato più di 20 aziende nei metodi, negli strumenti e nei processi della professione del comunicatore tecnico.