GUIDA PER SCRIVERE MANUALI

Considerazioni

Non scrivere 'troppo' e suddividere il testo in brevi paragrafi accompagnati da alcune foto. Queste illustreranno solo i punti salienti della procedura.

Potranno essere anche degli screenshot, come nel caso di manuali d'uso su un software, e non dovranno mai essere troppo pesanti in termini di Kb.

Verificare, prima di cominciare, che l'argomento prescelto non sia già inflazionato dalla presenza di numerosi manuali online. Controllate con Google!

Leggere tanti manuali online, per prendere spunto e per sperimentare su se stessi quali siano gli approcci che più facilitano l'apprendimento.

Realizzazione

Dotarsi di un Editor di testo o di un Editor Html, grazie al quale si scriverà il manuale ed, eventualmente, il codice per renderlo un 'documento Html'. Vedere al proposito la pagina Manuali con Html.

Approfondire le proprie conoscenze sulla scrittura di manuali, prima di realizzare l'opera, può essere positivo. Interessanti, sul Technical Writing, sono la pagina sulla Manualistica del sito ErgoSum, e il sito Il mestiere di scrivere, dedicato a vari tipi di 'scritture'.