Tecniche di scrittura manuale

Tecniche di scrittura manuale

Scrittura tecnica o istruzioni manuali chiamate per linguaggio conciso, facile--capisca e presentazione. Ci sono diverse tecniche di base che consentono di creare questo tipo di presentazione. Ognuno aiuta a presentare le informazioni in modo chiaro nel manuale. Tuttavia, il processo di scrittura manuali efficace inizia con una ricerca efficace dell'argomento. Comprendere l'argomento e quindi utilizzare queste tecniche per presentare le informazioni in modo più efficace possibile.

Introduzione

L'intro definisce il manuale. Spiegare chi dovrebbe leggere il documento e chi non è significava per, quali informazioni sono incluse e in quali circostanze è utile. Per i manuali di prodotto, si supponga il lettore ha acquistato il prodotto ed è pronto per imparare a usarlo. Tenere l'introduzione breve modo l'utente ottiene agli aspetti tecnici del manuale più rapidamente possibile.

Contorni

Manuali tecnici sono spesso strutturate in sezioni e sottosezioni, che anche fare un contorno ideale. Elencare tutte le sezioni previste per le sottosezioni di dettagliato manuale e incluse, ove necessario. Non abbiate paura di riorganizzare le sezioni come lei progressi. Solo perché pensato di argomento che una prima non significa che il lettore deve in primo luogo quel po ' di informazioni. L'ordine finale delle sezioni deve riflettere la progressione naturale che l'utente farà imparando l'argomento. È possibile utilizzare un sostantivo e verbo nell'intestazione della sezione per definire la voce e l'azione all'interno della sezione.

Essere attivi

Ogni passaggio in un manuale tecnico indica il lettore in una singola azione che, quando eseguita con altri passaggi, conduce a un'azione completa. Numero i passaggi o hanno grafici "proiettili" per indicare i passaggi. In alcune situazioni, la procedura potrebbe essere sotto-fasi identificate da numeri o lettere sotto i passaggi di base. Scrittori hanno certa discrezionalità in quanto identificano i passaggi, ma devono essere coerenti in tutto il manuale.

Keep It Simple

Utilizzare il linguaggio più semplice che trasmette adeguatamente le informazioni. Non sapete chi leggerà il manuale e quanto bene essi conoscono il gergo tecnico dell'argomento. Evitare alti livelli di dettaglio o dettagli non necessari per trasmettere le informazioni. Frasi lunghe, più di 20 parole, tendono a scoraggiare i lettori. Frasi di meno di 10 parole possono dare al documento un suono taglio.

Illustrare il tema

Utilizzare grafici, grafici o fotografie per illustrare l'argomento. Queste immagini possono essere vale più di mille parole e tendono ad attirare l'attenzione del lettore. Se immagini grafiche non sono possibili, utilizzare frasi descrittive. Illustrazioni ed esempi verbali anche di permettere al lettore di visualizzare l'argomento.