Teknisk Skrivning 101 Del 2

I del 1 delt jeg nogle af mine tanker om at definere din målgruppe, hvilket skaber en skitse, som definerer dit formål og de stadier af skrivning. Nu vil jeg gerne tage et øjeblik og udvide området for at definere din målgruppe. For eksempel, hvad du har brug for at finde ud af om dem, og hvorfor.

Det første skridt er at finde ud af deres niveau af viden om emnet. Er de …
Expert niveau? – på et avanceret niveau om emnet
Semi-ekspertniveau? – på et mellemliggende niveau om emnet
Ikke-ekspertniveau? – har nogen forudgående kendskab til emnet

Det andet skridt er at finde ud af deres rolle i organisationen. Er de …
• Foresatte? – den højeste af autoritative tal i organisationen, såsom formanden eller næstformanden eller direktør. De, der træffer beslutninger, der påvirker hele organisationen
• Underordnede? – læsere på et niveau i organisationen lavere end den teknisk forfatter. Alt, hvad de bekymrer sig om, er, hvordan dokumentet påvirker deres job
• Peers? – læsere på samme niveau som den tekniske forfatter, men ikke nødvendigvis den samme afdeling eller område.

Og den tredje skridt er at finde ud af, hvorfor de vil læse din tekniske dokument i første omgang. Er det fordi …
• de skal? eller er blevet beordret til af deres manager
• de er virkelig interesseret i emnet
• de vil kun bruge det som reference, mens du udfylder deres daglige arbejdsopgaver?

Du kan være undrende, hvorfor disse trin er endnu vigtige for en teknisk forfatter. Nå, årsagen er, fordi hvis du skriver eller designe dit dokument i den forkerte sammenhæng, farve eller layout det kunne gøre eller bryde hele projektet.

For eksempel, behøver du ikke ønsker at skrive et dokument til foresatte uden kendskab til emnet i meget tekniske termer, heller ikke du ønsker at skrive på en nedladende måde enten. Der skal være en professionel balance mellem de to, der vil engagere den lærende og hjælpe dem assimilere de oplysninger effektivt og bruge det tekniske dokument effektivt

Lad &'; s. Se på et andet eksempel. Du skriver for et hold af dine kammerater, der har en mellemliggende til avanceret viden niveau. Hvad tror du ville være svaret af læserne, hvis du har oprettet et dokument, der forklarede selv den laveste tekniske udtryk som hvad er en &', mus &'; eller hvordan til “ klik på &" ;? De ville sandsynligvis være keder sig, og fornærmet på samme tid, don &'; t du tror

Så igen, det vigtigste er at definere din målgruppe ved at stille så mange spørgsmål som muligt?. Hvis du ender med for mange niveauer og organisatoriske roller i din målgruppe, kan du oprette 3 separate dokumenter, såsom en begyndere Guide, Intermediate brugervejledning og Advanced User Guide.

I del 3 Jeg ønsker at fokusere på, hvordan at samle ressourcerne og hvorfra, og hvad er grafiske hjælpemidler eller stikord indenfor teknisk dokumentation og hvordan du opretter dem. Indtil næste gang …

Ressource: Teknisk Skrivning:. Principper, strategier og Readings af Diana C. Reep (. 5. udgave) Pearson Education, Inc. 2003.