Teknisk skriving 101 Part I

Teknisk skriving har vært en lidenskap for meg i mange år. Jeg faktisk startet som en help desk støtte person dokumentere tekniske instruksjoner for ansatte og nyansatte, og deretter flyttet til prosjektarbeid dokumentere programmeringskode og tekniske spesifikasjoner for større prosjekter. I &'; ve også skrevet et kurs for et lokalsamfunn college i mitt område og lærte det også. Jeg ønsket å dele noen av mine innsikter fra dette kurset siden så mange deltakere fant den nyttig. De gjorde en gjennomgang i US1 Princeton avis! :-D

Uansett, jeg digress … etter min mening er det 4 nøkler til teknisk skriving og jeg referere til det som den DOPS metoden. La &'; s anmeldelse av hvert punkt

D er for Definere målgruppen – Ikke bare trenger du å vite hvem du skriver for, men du trenger å vite deres kunnskapsnivå og bevissthet om settet emnet. For eksempel, hvis du underviser MS Word til toppledere, og de vet ikke engang hvordan du bruker Outlook eller navigere i Windows, må du kanskje revurdere innholdet og språket du skriver på. Prøv å styre klar av komplekse tekniske termer og begynne med en grunnleggende gjennomgang av verktøylinjer eller selv hvordan du åpner programmet.

O er for Outline. Personlig mener jeg dette er nøkkelen til suksess. Jeg ser så mange forfattere bare sitte ned og begynne å skrive uten retning og du kan fortelle i flyten av sitt dokument. Du kan ikke bare følge deres “ tankegang &" ;. Ta deg tid til å skissere hele dokumentet fra innholdet på tittelsiden til og med grafiske notater, til de Overskriftene og innhold, hele veien til vedlegget, forlater TOC (innholdsfortegnelse) skal være ferdig sist. Stol på meg, vil du se en stor forskjell i flyten av dokumentene

P er for Definere din Formål – Jeg hater å bruke akronymer innsiden av akronymer, men jeg liker å referere til dette som triip teori. Ditt formål for å lage dokumentet kan være å undervise, anbefaler, Inform, interesse, eller overtale. For eksempel, hvis du er den teknisk skribent for et nytt program for Human Resources-avdelingen, og din jobb er å skrive et dokument for de ansatte som skal bruke denne nye søknaden, hva er formålet? I dette tilfellet, er det å lære. Her &'; s en annen: Hvis du er ansatt som teknisk skribent til å opprette et dokument utformet for å la ansatte om nye retningslinjer og prosedyrer, hva er formålet? I dette tilfellet, er svaret å informere. Du &'; re ikke å lage en anbefaling om at de følger prosedyrene eller prøver å interessere dem eller overtale dem til å følge de retningslinjer og prosedyrer; du må bare informere dem.

S er for de stadier av skriving. Jeg tror det er 3 trinn til trinn, så å si, og Nei jeg har ikke et akronym for denne. LOL De 3 trinnene er plan, utkast og revidere. Når du har fullført hele planen for dokumentet, herunder evaluering av publikum og detaljert oversikt med kanskje noen skisser, kan du begynne å lage din Draft dokumentet. Hvis du ikke er ny på teknisk skriving er du vel klar over at det første dokumentet laget er alltid et utkast. Du vil ha mange, mange revisjoner av flere personer før det endelige dokumentet er godkjent. Håper jeg gjorde &'; t skremme noen av ennå!

Så der har vi det, DOPS metoden av Cheryl McNeil. Det er så mye mer å Technical Writing, men jeg trodde jeg ville bare gi en forsmak på hva som kommer i min neste artikkel, Part II of Technical Writing 101. Inntil neste gang …

Ressurser for oppretting 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
.