.example-class,#example-id
opacity
writings Tech writing Gli elementi strutturali del manuale d'uso
| Gli elementi strutturali del manuale d'uso |
|
Prima di iniziare con la redazione della documentazione di prodotto è bene impostare il corretto approccio di lavoro. La maggioranza dei progettisti e techwriters commette l'errore di tuffarsi nella stesura del manuale senza averne prima definita la struttura. Essa può variare molto tra i diversi documenti e in relazione al prodotto da documentare, ma per tutte le situazioni vale il principio di adottare una struttura standard - magari adattata e/o modificata - che comprenda pure le dettagliate peculiarità del prodotto trattato. Quali sono gli elementi costitutivi del manuale? Gli elementi che vanno a comporre il manuale d'uso possono essere davvero pochissimi, oppure tantissimi il relazione al prodotto ma anche al genere di utenza che si va ad investire per la lettura. Ad esempio, un manuale officina, di impianto, di riparazione potrebbe necessitare di procedure alquanto complesse; un piccolo elettrodomestico, evidentemente, può benissimo essere dotato di istruzioni più che sufficienti già contenute in una mezza paginetta dalla grafica accattivante e ben curata. Entrambe le situazioni richiedono comunque un approccio organizzativo del tutto simile e incentrato sul procedimento "per esclusione", preferibile rispetto al più impreciso metodo "per inclusione" che presuppone un tipo di impostazione non strutturata ed approssimativa. Gli elementi strutturali del manuale Si procede con la soddisfazione di precisi requisiti introduttivi:
|