Come Scrivere un Manuale Partendo da Zero

Scrivendo un manuale su un compito importante che riguarda il tuo lavoro, puoi dare prova delle tue capacità ai tuoi superiori. Dimostra le tue abilità nel completare un progetto di scrittura da solo.

Passaggi

  1. 1
    Decidi l'argomento. Sii preciso sulla portata e sul raggio d'azione dell'argomento.
  2. 2
    Decidi per quale pubblico scrivere.
    • Stai scrivendo un manuale per principianti o per esperti (o una via di mezzo)?
    • Il pubblico dovrà riferirsi a un corso (che utilizza il manuale) o è autodidatta?
  3. 3
    Definisci esattamente quello di cui andrai a parlare nel manuale.
    • Esempio: stai scrivendo un manuale su "Come installare porte". Una sezione potrebbe essere sulle porte scorrevoli, un'altra sulle porte d'ingresso, un'altra ancora sulle porte che danno sul retro delle abitazioni.
  4. 4
    Decidi l'ordine logico con cui presentare il manuale. Non si tratta di un ordine logico di azioni. È probabile che alcuni argomenti debbano venire prima. Le attività incluse in ogni parte del manuale dovrebbero essere discusse inizialmente. Se ritieni che il lettore a cui ti rivolgi debba già avere le competenze per portare a termine il lavoro descritto nel manuale, prendi in considerazione di esporre le attività in un'appendice.
  5. 5
    Se il manuale userà una terminologia o un gergo tecnico, prepara un glossario. Se è poco probabile che il lettore già lo conosca, posiziona il glossario subito dopo il sommario. Aggiorna il glossario mentre scrivi il manuale.
    • Le definizioni dei termini nel glossario devono essere più precise possibili. Se il termine è un acronimo, come "Scuba", nella definizione spiega esaurientemente che significa "Self Contained Underwater Breathing Apparatus" (ovvero "apparato di respirazione subacqueo autonomo").
  6. 6
    Decidi quali argomenti sono necessari per approfondire la ricerca. Un manuale poco curato è inutile. Completa le ricerche preliminari prima di iniziare a scrivere.
  7. 7
    Decidi l'organizzazione per ogni sezione che andrai a scrivere.
    • Esempio: stai scrivendo un manuale sui computer. Hai una sezione chiamata "Risoluzione dei problemi". Potresti scrivere una parte sui problemi che riguardano lo spazio sul disco o un'altra sull'uso eccessivo della memoria.
  8. 8
    Organizza ogni sezione e sottosezione in base a un ordine logico, restringendo il campo del tema.
  9. 9
    Inizia a scrivere! Usa il tuo sistema di organizzazione come guida, ma modificalo se non funziona.
    1. Scrivi le descrizioni dei vari compiti.
    2. Scrivi gli esempi che il lettore può seguire per capire le istruzioni.
    3. Prepara le illustrazioni appropriate. Non aggiungerle finché il manuale non sarà terminato. Le illustrazioni dovranno essere adattate al testo.
    • Modifica le illustrazioni per dare suggerimenti su ciò che il lettore sta cercando di fare.
      1. Esempio 1: (Considera un elenco numerato) l'autore dovrebbe collegare un determinato problema a un determinato punto.
      2. Esempio 2: (Riordina) l'autore dovrebbe ampliare una riga di testo che era fuori ordine.
  10. 10
    Non plagiare altri autori! Abbi un punto di riferimento e/o un elenco di citazioni estrapolate da libri, manuali e autori che ti hanno fornito le informazioni che hai usato.
    • Niente distrugge la credibilità di uno scrittore più del plagio. Un giorno qualcuno potrebbe citare quello che hai scritto. Come ti sentiresti se qualcuno "rubasse" il tuo lavoro?
  11. 11
    Aggiungi le illustrazioni in modo appropriato. Adattale al documento. Non aver paura di usare lo spazio bianco.
  12. 12
    Correggi, correggi e correggi sempre. La correzione dovrebbe essere continua. Prendi appunti sugli errori o sulle omissioni. Correggili. Prendi appunti sui passaggi che potrebbero confondere gli altri. Riscrivili per rendere più facile la lettura. Trova varie persone che leggano il manuale per assicurarti il miglior risultato possibile.
      • Questo è l'ordine che consigliamo per revisionare il manuale:
        1. Correggi il lavoro tu stesso.
        2. Fai in modo che un amico lo revisioni.
        3. Trova un esperto (nel campo in cui stai scrivendo) che lo revisioni.
        4. (Se il manuale è per la tua azienda) fai in modo che il tuo capo riesamini il lavoro.
        5. Sottoponi il manuale alla revisione di un principiante.
        • Perché è importante che un principiante lo corregga? Il manuale deve essere comprensibile agli occhi delle persone inesperte che ti aspetti lo leggano.

Consigli

  • Assicurati che il frontespizio e le righe a piè di pagina riportino il TUO nome in quanto nome dell'autore! Stampa le copie del manuale prima di inviarlo elettronicamente. Fai in modo che chi revisiona il materiale scriva le note sulle pagine. Includi una "c", circondata da parentesi, a piè di pagina. La maggior parte dei programmi interpretano questo simbolo come diritto d'autore e lo dispongono correttamente. Il testo a piè di pagina dovrebbe contenere (c) accanto al tuo nome. Questo non impedirà alla tua azienda di copiarlo, ma ti garantirà la titolarità dell'opera.

Informazioni sull'Articolo

wikiHow è una "wiki"; questo significa che molti dei nostri articoli sono il risultato della collaborazione di più autori. Per creare questo articolo, autori volontari hanno collaborato apportando nel tempo delle modifiche per migliorarlo.

Categorie: Scrittura

In altre lingue:

English: Write a Manual from Scratch, Español: escribir un manual a partir de cero, Русский: написать инструкцию с нуля

Questa pagina è stata letta 532 volte.
Hai trovato utile questo articolo?