L'introduzione definisce il manuale . Spiegare che dovrebbero leggere il documento e che non è vero significato per , quali informazioni è incluso e in quali circostanze è utile . Per i manuali dei prodotti , assume il lettore ha acquistato il prodotto ed è pronto per imparare a usarlo . Mantenere l'introduzione a breve in modo che l'utente ottiene agli aspetti tecnici del manuale il più rapidamente possibile .
Contorni
Manuali tecnici sono spesso disposti in sezioni e sottosezioni , che anche fare un contorno ideale . Elencare tutte le sezioni previste per il manuale e incluso sottosezioni dettagliate se necessario . Non abbiate paura di riorganizzare le sezioni , come si procede . Solo perché si pensava di argomento Un primo non significa che il lettore ha bisogno di quel po 'di informazioni di prima . L' ordine finale delle sezioni dovrebbe rispecchiare la progressione naturale che l'utente farà , mentre l'apprendimento del tema . Utilizzare un sostantivo e verbo l'intestazione per definire l'articolo e l'azione all'interno della sezione .
Essere attivo
Ogni passo in un manuale tecnico indica al lettore in una singola azione che , se eseguito con altri passi , porta ad una azione completa . Numero dei passi o hanno grafici " proiettili" per indicare i passi . In alcune situazioni , i passaggi possono essere sotto-fasi identificate da numeri o lettere sotto i passi base . Gli scrittori hanno una certa discrezionalità nel modo in cui identificano passi , ma devono essere coerenti in tutto il manuale .
Keep It Simple
Utilizzare il linguaggio semplice che veicola adeguatamente le informazioni . Tu non sai chi leggerà il manuale e quanto bene essi sono versati nel gergo tecnico del tema . Evitare un alto grado di dettaglio o dettagli non necessari per trasmettere le informazioni . Frasi lunghe , più di 20 parole , tendono a scoraggiare i lettori . Sentenze di meno di 10 parole possono dare al documento un suono tagliere .
Illustrare l'argomento
Utilizzare fotografie , diagrammi o grafici per illustrare il tema . Queste immagini possono valere più di mille parole e tendono ad attirare l'attenzione del lettore . Se le immagini grafiche non sono possibili , utilizzare frasi descrittive . Esempi verbali e le illustrazioni consentono anche al lettore di visualizzare l'argomento .