micrografica, Sabato 04 Settembre 2010
home writings tech writing Il genere letterario del manuale


Il genere letterario del manuale
Scritto da Redazione   
Il modus scrivendi del manuale d'uso non ha origine nella contemporaneità.
La forma espositiva degli antichi naturalisti è quasi tutta riconducibile al genere manualistico.
I trattati sulla natura, la cosmologia, la scrittura scientifica e speculativa venivano consegnati alla storia, con le dovute eccezioni, in forma di analisi tecnica.
La letteratura ha spesso attinto al genere documentario per descrivere la realtà e per offrire spunti all'analisi espressiva o soltanto perché lo stile è l'unico adatto a fornire il resoconto scritto di minuziosi dettagli e puntualizzazioni.

Le competenze per poter progettare professionalmente un manuale d'uso sono moderatamente elevate, ma non tali da dover richiedere anche una laurea di indirizzo umanistico.
D'altronde, nella sua più autentica definizione, il manuale d'uso e manutenzione dovrebbe essere un documento autorevole, il più esaustivo relativamente al ciclo di vita di un manufatto, nel quale includere la sua descrizione, l'uso appropriato e la conservazione nel tempo.

I moderni manuali destinati ai prodotti di fabbricazione contengono solitamente i seguenti indirizzi di informazione:
  1. avvertenze
  2. installazioni e allacciamenti
  3. istruzioni per il montaggio
  4. istruzioni per l'uso
  5. istruzioni per la manutenzione (si tratti di personale qualificato od utente finale)
  6. istruzioni per la revisione e riparazione (solitamente trattate separatamente e successivamente)
  7. istruzioni per lo smantellamento, la demolizione e lo smaltimento (macchine e impianti)
  8. lista delle parti di ricambio (soprattutto i componenti che garantiscono sicurezza d'uso)
Tali informazioni possono essere presentate in modo unitario o suddivise in più volumi, dipendentemente dalla complessità dell'apparecchiatura da documentare o anche soltanto dal tipo di scelta che si intende fare circa le informazioni sul prodotto.
La struttura modulare del manuale d'uso è la forma più consigliabile, tanto per la coerenza e l'ordine delle informazioni, quanto per la facilitazione logica in fase di progetto e successiva gestione.

Non esiste una sostanziale differenza tra un manuale d'uso fortemente strutturato e un semplice foglio istruzioni da allegare al prodotto. La distinzione è soltanto formale perché la differenza non è data dalla quantità di pagine, ma dalla qualità delle informazioni da fornire. Se un prodotto è complesso, ci si attende una notevole mole di informazioni per descriverlo e per istruire l'utilizzatore. D'altronde in corso di progettazione delle informazioni necessarie per un prodotto più semplice - quale è un foglio istruzioni - non si deve essere indotti a pensare che le informazioni debbano essere di qualità inferiore o di contenuti superficiali.

L'orientamento pratico di un buon redattore di documentazione tecnica dovrebbe sempre avere come tendenza la redazione di istruzioni più dettagliate possibili cercando di contenerle in poco spazio. Il problema si pone allorché le informazioni sono complesse e anche numerose. A conforto di questa reale necessità viene in soccorso il flusso organizzativo ricavabile dai principi generali di composizione di un libro, nella fattispecie gli stili in uso nell'ambito saggistico.

In sintesi, il formato editoriale del manuale d'uso dovrebbe ricalcare il seguente modello:
  • Copertina frontespizio (contenente macroinformazioni quali titolo, serie, modello, versione, immagine complessiva)
  • Indice generale o sommario (elenco sequenziale dei contenuti organizzato per titoli di capitoli e paragrafi)
  • Presentazione delle informazioni (qui trovano posto anche eventuali "disclaimer", cenni normativi e principali avvertenze)
  • Descrizione delle procedure
  • Utilizzo di riferimenti incrociati nel corpo del testo
  • Ricorso ad immagini e pittogrammi organizzate sul principio vedere capire
  • Accessi evidenti (brevi schede e trafiletti di riassunto dei concetti precedentemente sviluppati, percorsi di lettura o parole chiave)
  • Glossario delle evidenze e dei termini speciali utilizzati (nella redazione di manuali destinati ad un vasto pubblico si consiglia di limitare al massimo l'uso di terminologia specialistica)
  • Nel caso di informazioni particolarmente complesse è buona prassi posporre un indice analitico, che può essere quotato secondo necessità (es. per termini e nomi notevoli, per argomento, per paragrafo, per similitudine, ecc.)
 
Credits © 2010 micrografica sas - 41012 Carpi (MO) Italy - Via della Rosa, 12/c - Codice Fiscale e Partita Iva 02201200363
Condizioni di utilizzo  |  Informazioni sulla privacy
JoomlaWatch 1.2.11 - Joomla Monitor and Live Stats by Matej Koval