Scrittura tecnica 101 Parte I

Scrittura tecnica è stata una mia passione da anni. Ho iniziato come una persona Help Desk supporto documentare istruzioni tecniche per i dipendenti e nuovi assunti, e poi spostato sul progetto di lavoro la documentazione del codice di programmazione e le specifiche tecniche per i grandi progetti. I &'; ve anche scritto un corso per un college locale nella mia zona e insegnato pure. Ho voluto condividere alcune delle mie intuizioni da questo corso da molti partecipanti hanno trovato utile. Hanno anche fatto una recensione sul giornale US1 Princeton! :-D

Comunque, sto divagando … a mio parere ci sono 4 chiavi per scrittura tecnica e mi riferisco ad essa come metodo DOPS. Diamo &'; s rivedere ogni punto

D è per definizione il tuo Pubblico – Non solo è necessario sapere chi si sta scrivendo per, ma è necessario conoscere il loro livello di conoscenza e consapevolezza del tema insieme. Ad esempio, se si sta insegnando MS Word per dirigenti e non si sa nemmeno come utilizzare Outlook o navigare in Windows, potrebbe essere necessario rivalutare il contenuto e la lingua nella quale si scrive. Cercate di evitare di complesso termini tecnici e cominciano con una revisione di base delle barre degli strumenti o addirittura come aprire l'applicazione.

O è per Outline. Personalmente credo che questa sia la chiave del successo. Vedo tanti scrittori semplicemente sedersi e iniziare a scrivere senza una direzione e si può dire nel flusso della loro documento. Semplicemente non si può seguire la loro “ di pensieri &" ;. Prendetevi il tempo per delineare l'intero documento dal contenuto del frontespizio e persino note grafica, ai titoli delle sezioni e dei contenuti, fino all'appendice, lasciando il TOC (Table of Contents) da completare scorso. Fidati di me si vedrà una grande differenza nel flusso dei documenti

P è per definizione il vostro scopo – Odio usare acronimi all'interno di sigle, ma mi piace fare riferimento a questo come la teoria Triip. Il vostro scopo per la creazione del documento potrebbe essere quello di insegnare, Consigliare, Informare, interesse, o convincere. Per esempio, se siete il technical writer per una nuova applicazione software per il reparto Risorse Umane, e il vostro compito è quello di scrivere un documento per le dipendenti che utilizzeranno questa nuova applicazione, qual è il tuo scopo? In questo caso, è di insegnare. Qui &'; s un altro: Se si è assunto come un technical writer per creare un documento progettato per consentire i dipendenti conoscere nuove politiche e procedure, qual è il suo scopo? In questo caso, la risposta è di informare. You &'; re non fare una raccomandazione che seguono le procedure o cercando di interessarli o persuaderli a seguire le politiche e le procedure; è necessario informarli semplicemente.

S è per le fasi di scrittura. Credo che ci sono 3 passi per gli stadi, per così dire, e No non ho un acronimo per questo. LOL I 3 passi sono piano, progetto e rivedere. Dopo aver completato il piano intero del documento, compresa la valutazione del pubblico e lo schema dettagliato con forse qualche schizzi, si può cominciare a creare il progetto di documento. Se non siete nuovi a scrittura tecnica si sono ben consapevoli del fatto che il primo documento creato è sempre un progetto. Avrete molte, molte revisioni da diverse persone prima che il documento finale è stato approvato. Spero didn &'; t spaventare nessuno fuori ancora!

Quindi non abbiamo, il metodo DOPS da Cheryl McNeil. C'è così tanto da Scrittura tecnica, ma ho pensato solo fornire un'anteprima di quello che verrà nel mio prossimo articolo, parte II della Scrittura tecnica 101. Fino alla prossima volta …

Risorse per la creazione di outlines:

http://owl.english.purdue.edu/handouts/general/gl_outlin.html
http://www.albany.edu/eas/170/outline.htm
http://wiki.ehow.com/Write-an-Outline
.