Technisch schrijven 101 Deel I

Technisch schrijven is een passie van mij al jaren. Ik heb eigenlijk begonnen als een helpdesk support persoon documenteren van technische instructies voor werknemers en nieuwe aanwervingen, en vervolgens verplaatst naar projectwerk documenteren programmeercode en technische specificaties voor grotere projecten. I &'; ve schreef ook een cursus voor een lokale gemeenschap college in mijn omgeving en leerde het ook. Ik wilde een aantal van mijn inzichten te delen van deze cursus aangezien zo veel deelnemers vonden het nuttig. Ze hebben zelfs een recensie in de krant US1 Princeton! :-D

Hoe dan ook, ik dwaal … in mijn mening zijn er 4 sleutels tot technisch schrijven en ik zie het als de DOPS methode. Let &'; s te beoordelen elk punt

D is voor het definiëren van uw doelgroep – Niet alleen heb je nodig om te weten wie je schrijft voor, maar je nodig hebben om hun kennisniveau en het bewustzijn van de set onderwerp weten. Bijvoorbeeld, als je het onderwijzen van MS Word om topbestuurders en ze weet niet eens hoe je Outlook gebruikt of navigeren in Windows, moet u opnieuw te evalueren uw inhoud en de taal waarin u schrijft. Probeer duidelijk van complexe te sturen technische termen en beginnen met een fundamentele herziening van de werkbalken of zelfs hoe de toepassing te openen.

O is voor Outline. Ik persoonlijk denk dat dit is de sleutel tot succes. Ik zie zoveel schrijvers gewoon gaan zitten en beginnen met het schrijven met geen richting en u kunt vertellen in de stroom van hun document. Je kan gewoon niet hun &ldquo te volgen; gedachtegang &" ;. Neem de tijd om het hele document een overzicht van de inhoud van de titelpagina en zelfs grafische notities, naar de sectie titels en de inhoud, de hele weg naar de bijlage, waardoor de TOC (Inhoudsopgave) laatste worden afgerond. Geloof me je zal een groot verschil in de stroom van uw documenten zien

P is voor het definiëren van uw doel – Ik haat het om afkortingen te gebruiken binnenkant van acroniemen, maar ik willen verwijzen naar dit als de Triip theorie. Je doel voor het maken van het document zou kunnen zijn om les te geven, adviseren, informeren, rente, of overreden. Bijvoorbeeld, als je de technische schrijver voor een nieuwe software-applicatie voor de afdeling Human Resources, en uw taak is om een ​​document voor de werknemers die zullen worden met behulp van deze nieuwe toepassing te schrijven, wat is uw doel? In dit geval is het te leren. Here &'; s een ander: Als u ingehuurd als technisch schrijver om een ​​document ontworpen dat medewerkers weten over nieuw beleid en procedures te creëren, wat is uw doel? In dit geval is het antwoord te informeren. U &'; re niet het maken van een aanbeveling dat ze volgen de procedures of proberen ze te interesseren of overtuigen hen om het beleid en de procedures te volgen; je moet ze gewoon te informeren.

S is voor de Stadia van het schrijven. Ik geloof dat er 3 stappen om de stadia, om zo te zeggen, en Nee, ik niet een acroniem voor dit één te hebben. LOL De 3 stappen zijn plan, ontwerp en herzien. Nadat u uw hele plan te voltooien voor het document, met inbegrip van de evaluatie van uw doelgroep en de gedetailleerde schets met misschien een paar schetsen, kunt u beginnen om uw ontwerp-document te creëren. Als u niet nieuw voor technisch schrijven u weet dat uw eerste document gecreëerd is altijd een ontwerp. Je zult vele, vele herzieningen hebben door verschillende mensen voordat het definitieve document is goedgekeurd. Hoop dat ik niet &'; t schrikken iedereen off nog!

Dus daar hebben we het, de DOPS methode door Cheryl McNeil. Er is zo veel meer te Technisch schrijven, maar ik dacht dat ik zou gewoon zorgen voor een preview van wat er komen in mijn volgende artikel, deel II van Technical Writing 101. Tot de volgende keer …

Bronnen voor het creëren 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
.