Teknisk Skrivning 101 Del I

Teknisk Skrivning har været en passion af mine i årevis. Jeg faktisk startede som en Help Desk støtteperson dokumenterer tekniske anvisninger for medarbejdere og nyansatte, og derefter flyttes over på projektarbejde dokumentere programmering kode og tekniske specifikationer for større projekter. I &'; ve også skrevet et kursus for en lokal Community College i mit område og underviste det så godt. Jeg ønskede at dele nogle af mine indsigter fra dette kursus, da så mange deltagere fandt det nyttigt. De har endda gjorde en gennemgang i US1 Princeton avisen! :-D

Anyway, jeg sidespring … efter min mening er der 4 nøgler til teknisk skrivning og jeg henvise til det som den DOPS metoden. Lad &'; s gennemgå hvert punkt

D er for at definere din målgruppe – Ikke alene har du brug for at vide, hvem du skriver til, men du har brug for at kende deres vidensniveau og bevidsthed om den indstillede emne. For eksempel, hvis du underviser MS Word til topledere og de ved ikke engang, hvordan man bruger Outlook eller navigere i Windows, kan du nødt til at revurdere dit indhold og det sprog, du skriver i. Prøv at styre fri af komplekse tekniske termer og begynde med en grundlæggende gennemgang af værktøjslinjer eller endda hvordan at åbne programmet.

O er til Disposition. Personligt mener jeg det er nøglen til succes. Jeg ser så mange forfattere bare sætte sig ned og begynde at skrive med nogen retning, og du kan fortælle i strømmen af ​​deres dokument. Du kan simpelthen ikke følge deres “ tankegang &" ;. Tag dig tid til at skitsere hele dokumentet fra indholdet på titelbladet og endda grafiske noter til afsnittet titler og indhold, hele vejen til tillægget, forlader TOC (indholdsfortegnelse), der skal udfyldes sidst. Tro mig, du vil se en stor forskel i strømmen af ​​dine dokumenter

P er for at definere dit formål – Jeg hader at bruge akronymer indersiden af ​​akronymer, men jeg gerne henvise til dette som TRIIP teori. Deres formål for at skabe dokument kunne være at undervise, anbefaler, Inform, Renter, eller overtale. For eksempel, hvis du er den tekniske skribent for en ny software-applikation til Human Resources afdeling, og din opgave er at skrive et dokument til de medarbejdere, der skal bruge denne nye applikation, hvad er dit formål? I dette tilfælde er det at undervise. Her &'; s anden: Hvis du ansat som teknisk forfatter til at oprette et dokument designet til at lade medarbejderne vide om nye politikker og procedurer, hvad er dit formål? I dette tilfælde er svaret at informere. Du &'; re ikke laver en anbefaling, at de følger de procedurer, eller forsøger at interessere dem eller overtale dem til at følge de politikker og procedurer; du skal blot informere dem.

S er for Stadier af Writing. Jeg tror, ​​der er 3 trin til trin, så at sige, og nr jeg har ikke et akronym for denne. LOL De 3 trin er planen, udkast og revidere. Når du er færdig med hele din plan for dokumentet, herunder evaluering af din målgruppe og detaljeret oversigt med måske et par skitser, kan du begynde at oprette din Udkast dokument. Hvis du ikke er ny teknisk skriftligt du er godt klar over, at dit første dokument oprettet er altid et udkast. Du vil få mange, mange revisioner af flere personer, før det endelige dokument er godkendt. Håber jeg didn &'; t skræmme nogen væk endnu!

Så der har vi det, DOPS metode, Cheryl McNeil. Der er så meget mere at tekniske skriftligt, men jeg troede, jeg ville bare give en forsmag på hvad der skal komme i min næste artikel, del II i tekniske skriftligt 101. Indtil næste gang … Salg

Ressourcer for at skabe 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
.