Scrivere manuali tecnici o d'istruzione richiede linguaggio conciso, facile da capire e presentazione chiara. Esistono diverse tecniche base per creare questo tipo di presentazione. Ognuna aiuta a presentare l'informazione chiaramente. Tuttavia, il processo inizia con una ricerca efficace dell'argomento. Capisci l'argomento e poi usa queste tecniche per presentarlo il più efficacemente possibile.
L'intro definisce il manuale. Spiega chi deve leggere il documento e chi no, quali info include e in quali circostanze è utile. Per manuali di prodotto, assumi che il lettore abbia acquistato il prodotto e sia pronto a imparare a usarlo. Tieni l'intro breve così l'utente arriva agli aspetti tecnici il più velocemente possibile.
I manuali tecnici sono spesso disposti in sezioni e sottosezioni, che fanno da outline ideale. Elenca tutte le sezioni pianificate e includi sottosezioni dettagliate dove necessario. Non temere di riordinare le sezioni mentre progredisci. Solo perché hai pensato all'argomento A per primo non significa che il lettore ne abbia bisogno per primo. L'ordine finale dovrebbe riflettere la progressione naturale dell'utente nell'apprendimento. Usa sostantivo e verbo nell'intestazione per definire l'elemento e l'azione nella sezione.
Ogni passo in un manuale tecnico istruisce il lettore in una singola azione che, eseguita con altri passi, porta a un'azione completa. Numera i passi o usa "pallini" grafici. In alcune situazioni, i passi possono essere sotto-passi identificati da numeri o lettere sotto i passi base. Gli scrittori hanno discrezione su come identificare i passi, ma devono essere coerenti in tutto il manuale.
Usa il linguaggio più semplice che adeguatamente conveye l'informazione. Non sai chi leggerà il manuale e quanto conosce il gergo tecnico. Evita alti livelli di dettaglio o dettagli non necessari. Frasi lunghe, oltre 20 parole, scoraggiano i lettori. Frasi sotto 10 parole danno un suono spezzettato.
Usa fotografie, grafici o diagrammi per illustrare. Queste immagini valgono mille parole e attirano l'occhio. Se immagini grafiche non sono possibili, usa frasi descrittive. Esempi e illustrazioni verbali permettono al lettore di visualizzare l'argomento.