Manuale: differenze tra le versioni

Versione delle 16:31, 9 mag 2006

Versione attuale delle 10:22, 8 set 2025

(80 versioni intermedie di 48 utenti non mostrate)

Riga 1:

{{Nota disambigua|la tastiera degli strumenti musicali|Manuale (organo)}}

Il '''manuale''' è un documento, cartaceo o elettronico, volto a spiegare il funzionamento di un prodotto, dispositivo o servizio.

{{F|editoria|luglio 2016}}

[[File:Bernoullis Vademecum des Mechanikers.jpg|right|thumb|''Vademecum des Mechanikers'' del [[Bernoulli (famiglia)|Bernoulli]], quindicesima edizione, edito a [[Stoccarda]] nel 1874.]]

Un '''manuale''' è un'opera che compendia gli aspetti essenziali di una determinata disciplina o di un argomento, generalmente in funzione delle esigenze divulgative o didattiche del pubblico al quale è destinata<ref>Giuliano Vigini, ''Glossario di biblioteconomia e scienza dell'informazione'', Milano 1985, pag. 70.</ref>.

Il termine è la traduzione {{Greco antico|Ἐγχειρίδιον|enchiridion|nopunti=X|da=X}}, che indica un oggetto da tenere a portata di mano (''en-cheir''); la fortuna del termine si deve alla grande diffusione del testo filosofico stoico ''[[Manuale di Epitteto]]'' ({{Greco antico|Ἐγχειρίδιον Ἐπικτήτου|Enkheirídion Epiktḗtou}}), una raccolta di massime da tenere sempre presenti.<ref>https://www.treccani.it/enciclopedia/manuale/</ref> La coniazione del termine italiano si attribuisce a [[Ulrico Hoepli]], mentre [[Giuseppe Colombo (ingegnere)|Giuseppe Colombo]] fu autore del famoso ''Manuale dell'ingegnere''.

==Tipologie di manuali==

Per uno stesso prodotto possono essere redatti diversi tipi di manuale, destinati a diverse categorie di utilizzatori.

== Terminologia sinonomica ==

* '''Manuale Utente''': destinato all'utilizzatore finale del prodotto, che si presuppone privo di competenze tecniche specifiche. Spesso questa è l'unica documentazione allegata ai prodotti di consumo.

Può essere detto anche ''vademecum'' (dal [[lingua latina|latino]] "''vade mecum"'' che significa "''va' con me"'', con il significato figurativo ''ti do una mano''): si tratta di una guida o formulario contenente le nozioni più importanti di un argomento generale ([[scientifico]], [[tecnico]], [[arte|artistico]]…), un [[compendio]] di informazioni riguardanti un particolare campo o tecnica, creato per fornire risposte rapide e concise su un particolare argomento.<ref>{{cita web|url=http://www.treccani.it/vocabolario/vademecum/|titolo=Vademecum|editore=Enciclopedia Treccani, vocabolario online}}</ref>

* '''Istruzioni di montaggio''', allegate a prodotti che l'utente deve montare, ad esempio alcune categorie di mobili.

* '''Manuale dell'Installatore''', destinato a chi deve installare un apparato o strumento, che poi sarà utilizzato da altri.

* '''Manuale dell'Operatore''': destinato all'utilizzatore di uno strumento specialistico, ad esempio uno strumento elettronico di misura, in cui si presuppone una competenza specifica dell'utilizzatore.

* '''Manuale di Servizio''', necessario al personale preposto all'assistenza, per gli interventi di manutenzione, taratura periodica, e ricerca guasti. Riporta informazioni tecniche specifiche non necessarie il normale utilizzo del prodotto.

Coin ''manuale dell'utente'', o ''guida all'uso'', s'intende la pubblicazione tecnica che contiene le informazioni utili al corretto utilizzo di un dispositivo, di un [[attrezzo]] o di un utensile.

Nel caso dei prodotti informatici, si possono individuare alcune categorie più specifiche di manuali:

* '''Manuale Utente''', che quando è realizzato in formato elettronico è detto anche '''Help in linea'''.

** '''Help contestuale''', ovvero l'insieme dei messaggi di aiuto che l'utente riceve automaticamente o a richiesta, e che sono collegati alla specifica sezione del [[Programma (informatica)|programma]] che l'utente stà utilizzando.

* '''Manuale dell'Amministratore di sistema''', destinato a chi ha la responsabilità di installare il prodotto su uno o più [[computer]], configurarlo, installare gli aggiornamenti, risolvere i malfunzionamenti e garantirne il buon funzionamento nel tempo.

* '''Manuale di personalizzazione''': alcuni prodotti complessi, ad esempio programmi di contabilità, archivio, magazzino, richiedono un importante lavoro di configurazione e personalizzazione per adattarli all'utilizzo a cui sono destinati. Questa attività richiede una competenza specifica sul programma, che viene riassunta in questo manuale.

* '''Manuale dell'Amministratore del servizio''', destinato a chi deve gestire un servizio dal punto di vista dei contenuti applicativi, ad esempio il gestore di una [[mailing list]] o di un [[forum]], che può avere la responsabilità di moderare i contenuti inseriti dagli utenti.

* '''Manuale del programmatore''', documento che descrive l'organizzazione del [[codice sorgente]] del programma, destinato a chi dovrà effettuare modifiche nel programma stesso.

==Tipologie diTipologie manuali==

==Difficoltà nell'uso dei manuali==

[[File:Original packaging, cardboard box for the Mettoy Minor toy typewriter with instructions for use.jpg|thumb|Istruzioni originali per l'uso di un'antica macchina da scrivere giocattolo Mettoy Minor.]]

Molte persone, per quanto dotate di facoltà intellettuali nella norma, sono molto restie a leggere un manuale quando sarebbe necessario, e si trovano così a non riuscire ad utilizzare uno strumento di cui avrebbero bisogno, ad utilizzarlo solo per parte delle sue potenzialità, e a compiere errori talvolta catastrofici, o a cercare l'aiuto di qualcuno a loro noto per essere in grado di leggere un manuale.

Vi sono diversi tipi di manuali cartacei od in formato elettronico, a seconda del tipo di prodotto o servizio, di seguito alcuni esempi:

* Manuali per studenti.<ref>{{Cita web|lingua=it-it|url=https://www.historialudens.it/news/414-lezione-4a-il-manuale.html|titolo=Lezione 4a. Il manuale|sito=www.historialudens.it|data=2021-03-14|accesso=2025-08-28}}</ref>

* Manuali di istruzione:<ref>{{Cita web|lingua=it-IT|url=https://www.spai-srl.com/breve-storia-del-manuale-istruzioni/|titolo=Breve storia del manuale istruzioni|sito=SPAI|data=2019-09-19|accesso=2025-08-28}}</ref>

** '''Manuale Utente'''utente: destinato all'utilizzatore finale del prodotto, che si presuppone privo di competenze tecniche specifiche. Spesso questa è l'unica documentazione allegata ai prodotti di consumo. Quando è realizzato in formato elettronico è detto anche ''Guida'' o ''Aiuto''.

*** '''Help contestuale''', ovvero: l'insieme dei messaggi di aiuto che l'utente riceve automaticamente o a richiesta, e che sono collegati alla specifica sezione del [[Programma (informatica)|programma]] che l'utente stàsta utilizzando.

** '''Istruzioni di montaggio''',: allegate a prodotti che l'utente deve montare, ad esempio alcune categorie di mobili.

** '''Manuale dell'Installatore''',installatore: destinato a chi deve installare un apparato o strumento, che poi sarà utilizzato da altri.

** '''Manuale dell'Operatore'''operatore: destinato all'utilizzatore di uno strumento specialistico, ad esempio uno strumento elettronico di misura, in cui si presuppone una competenza specifica dell'utilizzatore.

** '''Manuale di Servizio''',servizio: necessario al personale preposto all'assistenza, per gli interventi di manutenzione, [[taratura]] periodica, e ricerca guasti. Riporta informazioni tecniche specifiche non necessarie per il normale utilizzo del prodotto.

Nel caso dei prodotti informatici, si possono individuare alcune categorie più specifiche di manuali:

Possibili spiegazioni per la difficoltà ad utilizzare i manuali:

* '''Manuale dell'Amministratoreamministratore di sistema''', destinato a chi ha la responsabilità di installare il prodotto su uno o più [[computer]], configurarlo, installare gli aggiornamenti, risolvere i malfunzionamenti e garantirne il buon funzionamento nel tempo.

* sovente gli autori di un manuale non hanno alcuna familiarità con i modi espressivi e i metodi didattici che potrebbero renderlo più adatto al suo scopo

* '''Manuale di personalizzazione''': alcuni prodotti complessi, ad esempio programmi di contabilità, archivio, magazzino, richiedono un importante lavoro di configurazione e personalizzazione per adattarli all'utilizzo a cui sono destinati. Questa attività richiede una competenza specifica sul programma, che viene riassunta in questo manuale.

* molti manuali sono tradotti da una lingua straniera, e spesso le traduzioni sono di bassa qualità, prodotte da traduttori automatici o da persone che evidentemente non hanno familiarità con la lingua in cui scrivono o che non hanno compreso il testo che traducono. Questo trasforma la lettura in un frustrante esercizio di interpretazione.

* '''Manuale dell'Amministratoreamministratore del servizio''', destinato a chi deve gestire un servizio dal punto di vista dei contenuti applicativi, ad esempio il gestore di una [[mailing list]] o di un [[forum (Internet)|forum]], che può avere la responsabilità di moderare i contenuti inseriti dagli utenti.

* molti ritengono la lettura di un manuale una perdita di tempo o un compito dequalificante, ma trovano perfettamente ragionevole sprecare molto più tempo e correre rischi cercando di capire il funzionamento dello strumento, oppure far perdere tempo ad un'altra persona per farsi leggere un documento che sarebbero benissimo in grado di leggere da soli.

* '''Manuale del programmatore''', documento che descrive l'organizzazione del [[codice sorgente]] del programma, destinato a chi dovrà effettuare modifiche nel programma stesso.

* alcuni arrivano a sostenere che le persone in grado di leggere i manuali tendono statisticamente ad avere una vita sociale molto povera, e che chiedere aiuto a costoro è una scusa per fare quattro chiacchere.

* Manuale delle [[Application programming interface|API]]: questo tipo di manuale descrive le modalità di utilizzo di un componente software come una [[Libreria (software)|libreria software]] o una [[Classe (informatica)|classe]], ed è destinato a chi deve utilizzare questo componente in un programma, senza doverne per forza conoscere tutte le caratteristiche interne.

* A volte il contenuto di due o più manuali è fornito in un unico documento dall'organizzazione non chiara, e questo talvolta genera difficoltà nell'individuare la parte di interesse e sconforto nel potenziale lettore.

* Può essere difficile trovare il manuale di cui si ha bisogno nel momento in cui se ne ha bisogno. Questo accade spesso per i manuali cartacei allegati ad elettrodomestici o simili, che vengono facilmente persi prima che ci si renda conto della loro utilità.

* Per i prodotti informatici, molti utenti non sanno dove cercare la documentazione in formato elettronico, che può trovarsi in un sistema di help on line specifico del [[sistema operativo]] ([[man (unix)|man]], [[info]], [[help di windows]]), in un file salvato da qualche parte, sul sito del produttore, su altri siti. Spesso è utile utilizzare un [[motore di ricerca]] per cercare la documentazione di un prodotto.

==Voci correlateGalleria ==

<gallery>

* [[FAQ]]

File:Oxygen480-categories-system-help.svg|L'icona di un [[punto interrogativo]], viene molto spesso utilizzata nelle [[Interfaccia grafica|interfacce grafiche]] o in determinati pulsanti fisici (come ad esempio nei [[Telecomando|telecomandi]]) per richiamare un menù di aiuto, o una guida su schermo.

File:Office-book.svg|L'icona di un libro viene anch'essa utilizzata per rappresentare una guida interattiva, l'icona è un riferimento ai manuali cartacei.

File:Gnome-help-browser.svg|L'icona di un salvagente è anch'essa utilizzata per rappresentare una guida, anche se più raramente.

</gallery>

==Note==

[[Categoria:documentazione]]

<references/>

== Voci correlate ==

* [[Documentazione tecnica]]

* [[Frequently asked questions]]

* [[Technical writer]]

== Altri progetti ==

{{Interprogetto|wikt=manuale}}

== Collegamenti esterni ==

* {{Collegamenti esterni}}

{{Controllo di autorità}}

{{Portale|editoria}}

[[Categoria:Opere letterarie per tipo]]

[[Categoria:documentazioneGuide]]