Manuale: differenze tra le versioni

Contenuto cancellato Contenuto aggiunto
Nessun oggetto della modifica
Botcrux (discussione | contributi)
m Bot: aggiungo template {{Collegamenti esterni}} (ref)
 
(52 versioni intermedie di 31 utenti non mostrate)
Riga 1:
{{Nota disambigua|la tastiera degli strumenti musicali|Manuale (organo)}}
{{F|informatica|agosto 2009}}
{{F|editoria|luglio 2016}}
Il '''manuale''' (sinonimo arcaico '''enchiridio''': entrambi i termini significano "da tenersi in mano") è un documento, cartaceo o elettronico, volto a spiegare il funzionamento di un prodotto, dispositivo o servizio.
[[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 ==
Si definisce manuale un libro che presenta sommariamente i temi più importanti di una determinata disciplina (ad esempio un manuale di storia della letteratura italiana è un libro destinato agli studenti liceali o universitari di letteratura italiana, ecc.)
 
== Terminologia sinonomica ==
Si chiamano manuali anche pubblicazioni tecniche relative a un prodotto commerciale.
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>
Per uno stesso prodotto possono essere redatti diversi tipi di manuale, destinati a diverse categorie di utilizzatori.
 
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.
* '''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.
* '''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 per il normale utilizzo del prodotto.
 
== Tipologie di manuali ==
Nel caso dei prodotti informatici, si possono individuare alcune categorie più specifiche di 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.]]
* '''Manuale Utente''', che quando è realizzato in formato elettronico è detto anche '''Help in linea'''.
Vi sono diversi tipi di manuali cartacei od in formato elettronico, a seconda del tipo di prodotto o servizio, di seguito alcuni esempi:
** '''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 sta utilizzando.
* 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>
* '''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.
* 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 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 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''.
* '''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 (internet)|forum]], che può avere la responsabilità di moderare i contenuti inseriti dagli utenti.
*** '''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 sta utilizzando.
* '''Manuale del programmatore''', documento che descrive l'organizzazione del [[codice sorgente]] del programma, destinato a chi dovrà effettuare modifiche nel programma stesso.
** '''Istruzioni di montaggio''',: allegate a prodotti che l'utente deve montare, ad esempio alcune categorie di mobili.
* '''Manuale delle [[Application programming interface|API]]''': questo tipo di manuale descrive le modalità di utilizzo di un componente software come una [[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.
** '''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:
== Difficoltà nell'uso dei 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.
{{chiarire|Molte persone|chi?}}, 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 a utilizzare uno strumento di cui avrebbero bisogno, a utilizzarlo solo per una parte delle sue potenzialità, a compiere errori e a cercare l'aiuto di qualcuno.
* '''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'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 (internetInternet)|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.
* '''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 [[classeClasse (informatica)|classe]], ed è destinato a chi deve utilizzare questo componente in un programma, senza doverne per forza conoscere tutte le caratteristiche interne.
 
== Galleria ==
Di seguito, possibili spiegazioni per la difficoltà a utilizzare i manuali.
<gallery>
*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.
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.
*Molti manuali multilingua sono in realtà tradotti tutti dalla lingua originale da traduttori automatici per risparmiare soldi e tempo, generando traduzioni inesatte e talvolta prive di senso; altre volte, le traduzioni sono eseguite da persone con poca familiarità con la lingue che interpretano male le espressioni.
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.
*C'è una diffusa tendenza a preferire i tentativi pratici nel primo utilizzo di un prodotto rispetto alla iniziale lettura di un manuale, per non sentirsi incompetenti o per non "perdere tempo a leggere" prima di utilizzare un prodotto appena acquistato.
File:Gnome-help-browser.svg|L'icona di un salvagente è anch'essa utilizzata per rappresentare una guida, anche se più raramente.
*A volte, il contenuto di due o più manuali è fornito in un unico documento dall'organizzazione non chiara e questo genera difficoltà nell'individuare la parte di interesse e sconforto nel potenziale lettore. Può succedere anche che un manuale fornito con un prodotto non sia specifico di quel prodotto, ma dell'intera serie: questo porta a far confusione tra l'aspetto esterno e le figure del manuale e tra le caratteristiche descritte e quelle realmente presenti nel prodotto.
</gallery>
*Per i prodotti informatici, la documentazione è spesso in formato elettronico e va ricercata nel sito del produttore, che può risultare dispersivo o disordinato.
 
==Note==
<references/>
 
== Voci correlate ==
* [[FAQDocumentazione tecnica]]
* [[Frequently asked questions]]
* [[Ulrico Hoepli]], a cui si attribuisce il conio del termine
* [[Technical writer]]
* [[Giuseppe Colombo (ingegnere)|Giuseppe Colombo]], autore del famoso "Manuale dell'ingegnere"
 
== Altri progetti ==
{{Interprogetto|wikt=manuale}}
 
== Collegamenti esterni ==
[[Categoria:Documentazione informatica]]
* {{Collegamenti esterni}}
 
{{Controllo di autorità}}
{{Portale|editoria}}
 
[[Categoria:Opere letterarie per tipo]]
[[Categoria:Guide]]