Creiamo la documentazione orientata ad utente

Usiamo le nuove tecnologie multimediali!

I comunicatori tecnici spesso lavorano in collaborazione tra di loro per creare prodotti (servizi disponibili) per i diversi mezzi di comunicazione. Uno di questi è il manuale d’uso e di manutenzione. I domini tecnici possono essere di qualsiasi tipo, ivi comprese le scienze sociali e le scienze sperimentali, l’elevata tecnologia, compreso i computer e il software, l’elettronica di consumo, i processi commerciali e le installazioni e gli impianti della grande industria.

Qual è lo scopo principale della stesura di manuali d’uso e di manutenzione?

E ovvio che un manuale deve essere esauriente, chiaro e deve rispettare gli standard del relativo settore. Un buon scrittore tecnico tiene presente anche delle informazioni che devono essere rilevanti e facilmente accessibili/ disponibili per il pubblico desiderato.

Il processo di sviluppo dei prodotti di informazione nella comunicazione tecnica inizia con il garantire che il tipo di pubblico e che le loro necessità di avere informazioni vengano chiaramente individuate. Da qui il comunicatore tecnico fa delle ricerche e organizza il contenuto in una struttura che può condurre ad uno sviluppo dettagliato.

La maggior parte dei manuali d’uso e di manutenzione contengono di solito sia una guida scritta che delle immagini associate. Nel caso di applicazioni del computer vengono normalmente inserite delle schermate su come il programma deve apparire e spesso nei manuali di hardware vengono inseriti dei diagrammi chiari, semplificati.

Tempo fa abbiamo fatto degli altri passi in avanti per sfruttare tutte le risorse che le nuove tecnologie ci offrono.

Ora inseriamo abitualmente video multimediali, file audio ed animazioni in tutti i nostri manuali.

Il risultato può essere un manuale stampabile in formato pdf che può essere normalmente consultato in rete, guardando un sito in fase di manutenzione in un video, che viene inserito nello stesso documento, o ascoltando una buona spiegazione audio.

Sempre di più i nostri clienti ci chiedono di pubblicare anche i loro manuali attraverso un accesso limitato al sito web, dove i loro clienti possono consultare i manuali con diversi livelli di accesso a seconda della loro funzione. Anche il livello di sicurezza è maggiore, perché un amministratore del sito può spesso modificare le password per gli utenti e i livelli di accesso del personale di manutenzione.

In questo modo risulta più semplice non soltanto distribuire un manuale e la relativa documentazione, ma anche rivederli e trasmetterli rapidamente all’utente finale.

Un valido esempio di ciò è rappresentato dal nostro cliente che fornisce linee di produzione alla grande industria:

Il manuale viene pubblicato su un sito web con accesso limitato, dove il personale può consultare i file con diversi livelli di accesso, a seconda della loro funzione. In questo caso gli utenti possono consultare i loro documenti che sono diversi da quelli che si rivolgono al personale di manutenzione. L’amministratore del sito può modificare le password di accesso, fornendole soltanto al personale che sta attualmente eseguendo le attività.