Technisch schrijven 101 Deel 2

In deel 1 gedeelde ik een aantal van mijn gedachten over het definiëren van uw doelgroep, het creëren van een schets, het definiëren van uw doel en de stadia van het schrijven. Nu zou ik graag een moment te nemen en uit te breiden op het gebied van het definiëren van uw doelgroep. Bijvoorbeeld, wat je nodig hebt om te weten te komen over hen en waarom.

De eerste stap is om uit te vinden het niveau van hun kennis over het onderwerp. Zijn ze …
Expert niveau? – op een gevorderd niveau van het onderwerp
Semi-expert niveau? – op een gemiddeld niveau van het onderwerp
Non-expert niveau? – hebben geen voorkennis van het onderwerp

De tweede stap is om uit te vinden hun rol in de organisatie. Zijn ze …
• Superieuren? – de hoogste van gezaghebbende figuren binnen de organisatie, zoals de president of vice-president of directeur. Degenen die beslissingen nemen die de hele organisatie van invloed zijn
• Ondergeschikten? – lezers op een niveau binnen de organisatie lager dan de technisch schrijver. Alles wat ze zorg over is hoe het document hun werk beïnvloedt
• Peers? – lezers op hetzelfde niveau als technisch schrijver, maar niet nood- afdeling of veld.

En de derde stap is om uit te vinden waarom zij uw technische document zal lezen in de eerste plaats. Is het omdat …
• ze moeten? of zijn besteld door hun manager
&bull?; ze zijn echt geïnteresseerd in het onderwerp
&bull?; ze zullen alleen worden gebruikt als referentie bij het invullen van hun dagelijkse werk taken?

Je kunt je afvragen waarom deze stappen zijn ook belangrijk om een ​​technisch schrijver. Nou, de reden is dat als je schrijft of een ontwerp van uw document in de verkeerde context, kleur of lay-out zou kunnen maken of breken het hele project.

Bijvoorbeeld, wil je niet om een ​​document naar superieuren te schrijven zonder kennis van het onderwerp in zeer technische termen, noch wil je schrijven in een vernederende wijze, hetzij. Er moet een professionele balans tussen de twee die de leerling zal betrekken en hen helpen de informatie efficiënt te assimileren en de technische documenten effectief te gebruiken

Let &';. S kijken naar een ander voorbeeld. Je schrijft een team van uw collega's die een gemiddeld tot gevorderd kennisniveau. Wat denk je dat zou de reactie van de lezers als u een document dat zelfs de laagste technische term uitgelegd zoals wat is een &' gemaakt, muis &'; of hoe je van “ click &" ;? Zouden ze waarschijnlijk vervelen en beledigd op hetzelfde moment, don &'; t je denkt

Dus nogmaals, de sleutel is om uw doelgroep te definiëren door te vragen zo veel vragen als mogelijk?. Als je eindigt met te veel niveaus en organisatorische rollen binnen uw doelgroep, moet u 3 afzonderlijke documenten, zoals een Beginners Guide, Intermediate gebruikershandleiding en gebruikershandleiding Geavanceerde creëren.

In deel 3 wil ik zich richten op hoe de middelen te verzamelen en van waar, en wat zijn de grafische hulpmiddelen of aanwijzingen in de technische documentatie en hoe om ze te maken. Tot de volgende keer …

Resource: Technisch schrijven:. Beginselen, strategieën en Lezingen door Diana C. Reep (. 5 ed) Pearson Education, Inc. 2003.