Come si realizza la documentazione tecnica e quale è il flusso di produzione di un manuale?
Vediamo sinteticamente le fasi di sviluppo; ne otterremo una sorta di albero di navigazione che ci consente di individuare le tematiche di nostro interesse e di approfondirle all’interno del sito COM&TEC
- PROGETTAZIONE
Si definisce il prodotto oggetto del manuale, i destinatari del manuale (installatore, riparatore o utilizzatore del prodotto) e i tempi di realizzazione.
In questa fase sono richieste ad esempio conoscenze di project management. - REQUISITI NORMATIVI
Devono essere individuati obblighi legali, i requisiti normativi ma anche linee guida di supporto (ad esempio CEI EN 62079).
In questa fase la conoscenza delle fonti normative (ad esempio Eur-lex) è la competenza base. - RACCOLTA INFORMAZIONI
I contenuti della documentazione vengono individuati attraverso interviste ai progettisti, attingendo a database aziendali e recuperando contenuti preesistenti (anche di prodotti analoghi a quello in oggetto).
Problem solving e tecniche di intervista le competenze necessarie in questa fase. - REDAZIONE e IMPAGINAZIONE
I contenuti devono essere strutturati, standardizzati e poi impaginati: guide di stile, scrittura professionale, controllo terminologico, conoscenze di software di publishing, impostazione del layout sono i ferri del mestiere in questa fase. - CONTROLLO
Il documento è pronto? Non ancora. La revisione, effettuata da un soggetto “terzo” cioè non dal redattore, è la fase che consente di individuare errori, sempre possibili, e di rendere “omogeneo” e coerente nel suo complesso tutto il documento.
Prevedere infine un test di usabilità da parte di probabili utenti consente spesso miglioramenti qualitativi inaspettati a fronte di investimenti anche minimi. - TRADUZIONE – LOCALIZZAZIONE
Competenze linguistiche supportate da strumenti quali CAT TOOLS, TM, database terminologici e linguaggi strutturati. - MANUTENZIONE
Anche la documentazione deve essere mantenuta. Tenere aperto il canale di comunicazione con i progettisti del prodotto e raccogliere i feedback provenienti dal servizio assistenza tecnica o dalla rete commerciale migliora la documentazione ma fa anche migliorare il redattore!
