Teknisk skriving 101 Part 2

I del 1 delte jeg noen av mine tanker om å definere målgruppen, lage en disposisjon, definere formålet og stadier av å skrive. Nå vil jeg gjerne ta et øyeblikk og utvide området for å definere målgruppen. For eksempel, hva du trenger for å finne ut om dem og hvorfor.

Det første trinnet er å finne ut deres nivå av kunnskap om emnet. Er de …
Expert nivå? – på et avansert nivå på emnet
Semi-ekspert nivå? – på et middels nivå på emnet
Non-ekspert nivå? – har ingen forkunnskaper om emnet

Det andre trinnet er å finne ut deres rolle i organisasjonen. Er de …
• Ordnede? – den høyeste av autoritative tall i organisasjonen, slik som president eller visepresident eller direktør. De som tar beslutninger som påvirker hele organisasjonen
• Underordnede? – leserne på et nivå i organisasjonen lavere enn teknisk forfatter. Alt de bryr seg om er hvordan dokumentet påvirker jobben sin
• Peers? – lesere på samme nivå som teknisk forfatter, men ikke nødvendigvis det samme avdeling eller felt.

Og det tredje trinnet er å finne ut hvorfor de skal lese det tekniske dokumentet i første omgang. Er det fordi …
• de må? eller har blitt beordret til av sin manager
• de er virkelig interessert i temaet
• de vil bare bruke den som referanse når du skal fylle sine daglige arbeidsoppgaver?

Du lurer kanskje på hvorfor disse trinnene er enda viktigere for en teknisk forfatter. Vel, grunnen er fordi hvis du skriver eller designe dokumentet i feil sammenheng, farge eller layout det kan gjøre eller ødelegge hele prosjektet.

For eksempel, om du ikke ønsker å skrive et dokument til overordnede uten kunnskap om emnet i svært tekniske termer, eller ønsker du å skrive i en nedlatende måte heller. Det må være en profesjonell balanse mellom de to som vil engasjere eleven og hjelpe dem assimilere informasjon effektivt og bruke teknisk dokument effektivt

La &'; s. Se på et annet eksempel. Du skriver for et team av dine kolleger som har en middels til avansert kunnskapsnivået. Hva tror du ville være responsen fra leserne hvis du har opprettet et dokument som forklarte selv den laveste tekniske betegnelsen for eksempel hva er en " mus &'; eller hvordan du “ klikk &" ;? De ville trolig bli lei og fornærmet på samme tid, don &'; t du tror

Så igjen, er nøkkelen til å definere målgruppen ved å stille så mange spørsmål som mulig?. Hvis du ender opp med for mange nivåer og organisatoriske roller i målgruppen din, kan det hende du trenger for å lage 3 separate dokumenter, for eksempel en nybegynner guide, Intermediate brukerhåndboken og avansert brukerhåndboken.

I del 3 vil jeg fokusere på hvordan å samle ressurser og fra hvor, og hva er grafiske hjelpemidler eller signaler innen teknisk dokumentasjon og hvordan du oppretter dem. Inntil neste gang …

Resource: teknisk skriving. Prinsipper, strategier og Readings av Diana C. Reep (. 5th ed) Pearson Education, Inc. 2003.