Tekniska Skriva 101 Del I

Teknisk Writing har varit en passion för mig i flera år. Jag började faktiskt ut som en Help Desk stödperson dokumentera tekniska instruktioner för anställda och nyanställda, och sedan flyttade till projektarbete dokumentera programkod och tekniska specifikationer för större projekt. I &'; ve också skrivit en kurs för en lokal community college i mitt område och undervisade det liksom. Jag ville dela några av mina insikter från den här kursen eftersom så många deltagare tyckte att det var bra. De gjorde även en översyn US1 Princeton tidningen! :-D

Hur som helst, göra en utvikning jag … enligt min mening finns det 4 nycklar till tekniska skribenter och jag hänvisar till det som DOPS metoden. Låt &'; s granska varje punkt Omdömen

D är för att definiera din målgrupp och ndash. Inte bara du behöver veta vem du skriver för, men du behöver veta deras kunskapsnivå och medvetenhet om den inställda ämnet. Till exempel, om du undervisar MS Word till ledande befattningshavare och de vet inte ens hur man använder Outlook eller navigera i Windows, kan du behöva omvärdera ditt innehåll och det språk du skriver in. Försök att undvika problem med komplexa tekniska termer och börja med en grundläggande översyn av verktygsfält eller ens hur man öppnar programmet.

Nollan är för Outline. Personligen tror jag att detta är nyckeln till framgång. Jag ser så många författare bara sitta ner och börjar skriva utan riktning och du kan berätta i flödet av deras dokument. Du kan helt enkelt inte kan följa deras “ tanke &" ;. Ta dig tid att beskriva hela dokumentet från innehållet i titelbladet och även grafiska anteckningar till avsnittet titlar och innehåll, hela vägen till tillägget, lämnar TOC (innehållsförteckning) ska fyllas i sist. Tro mig du kommer att se en stor skillnad i flödet av dina dokument Omdömen

P är för att definiera ditt syfte &ndash. Jag hatar att använda akronymer insidan av akronymer, men jag gillar att hänvisa till detta som Triip teorin. Ditt syfte för att skapa dokumentet kan vara att undervisa, rekommenderar, Informera, Interest, eller övertyga. Till exempel, om du är teknisk skribent för en ny programvara för personalavdelningen, och ditt jobb är att skriva ett dokument för de anställda som kommer att använda den nya ansökan, vad är ditt syfte? I detta fall är det att undervisa. Här och' s en annan: Om du är anställd som teknisk skribent att skapa ett dokument som syftar till att låta de anställda veta om nya riktlinjer och rutiner, vad är ditt syfte? I detta fall är svaret att informera. You &'; re inte göra en rekommendation att de följer de förfaranden eller försöker intressera dem eller förmå dem att följa de riktlinjer och rutiner; du behöver bara informera dem.

S är för Stadier i skrivande. Jag tror att det finns 3 steg till steg, så att säga, och Nej, jag har inte en akronym för detta. LOL De 3 stegen är planen, utkast och revidera. När du är klar hela din plan för dokumentet, inbegripet utvärdering av din målgrupp och detaljerad beskrivning med kanske några skisser, kan du börja skapa utkast till dokument. Om du inte är ny för teknisk dokumentation du är väl medveten om att din första dokument som skapas är alltid ett utkast. Du kommer att ha många, många revideringar av flera personer innan slutdokumentet godkänns. Hoppas jag gjorde &'; t skrämma någon av ännu!

Så där har vi det, DOPS metod Cheryl McNeil. Det finns så mycket mer att tekniska skriva, men jag trodde jag skulle bara ge en förhandsvisning av vad som komma skall i min nästa artikel, del II i Tekniska Skriva 101. Tills nästa gång …

resurser för att skapa 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
.