technisch schrijven is de praktijk van het verwerken van documenten en visuals, verbale informatie en demonstraties van instructiemateriaal. Het doel van technisch schrijven is om materiaal te leveren dat een proces verklaart of een complex concept voor een bepaald publiek gemakkelijker te begrijpen maakt. Door middel van efficiënt en effectief technisch schrijven, zal de schrijver in staat zijn om de lezer uit te leggen en te helpen Hoe informatie te begrijpen en specifieke taken uit te voeren. Er zijn vijf universele ethische principes van technisch schrijven. De principes zijn kwaliteit inhoud, publiek en doel, toegankelijkheid, grammatica, en schrijfstijl.
kwaliteitsinhoud
kwaliteitsinhoud is subjectief. MATC ‘ s definitie van content van hoge kwaliteit is een product dat voldoet aan de normen van een klant of verder gaat dan de oorspronkelijke reikwijdte van het project. Om een project van hoge kwaliteit te produceren, moet je schrijven met het beoogde publiek in het achterhoofd. De schrijver moet aanvullende kennis onderzoeken die nodig is voordat het document of materiaal is voltooid. De schrijver moet weten welk formaat of platform zal worden gebruikt om de informatie te vertegenwoordigen. De schrijver moet specifieke informatie bepalen die varieert van weten wat de deadlines zijn om te weten waarom de informatie moet worden geschreven.
publiek en doel
de schrijver moet zowel doel als publiek begrijpen om een uitstekend technisch stuk te maken. Het technisch schrijvende publiek varieert op de industrie en de specifieke klant. Bijvoorbeeld, het publiek van een lap rapport zou de product manufacture die ons ingehuurd als schrijvers zijn. Het publiek voor een eLearning training module kan een bank of hypotheek provider die compliance training nodig. De schrijver moet weten hoeveel de lezers zullen weten en wat de verantwoordelijkheden van de schrijver is vereist om te vervullen als het gaat om het communiceren met de lezers.
toegankelijkheid
het is essentieel dat het publiek gemakkelijk toegang heeft tot de informatie die de schrijver heeft gemaakt. Toegankelijkheid omvat alles wat zich op een document bevindt, zoals kop-en voetteksten, of op computer iLearn-modules, die de toegankelijkheidsopmaak verbeteren om universeler en duidelijker te zijn. De technische schrijver moet uitzoeken wat de beste methode om lezers te helpen navigeren door de documentatie met notaties van een bibliografie naar een paginanummers naar een inhoudsopgave. De schrijver kon zelfs visuals toevoegen, zoals grafieken en figuren, om informatie verder uit te leggen.
grammatica
schrijven helder, beknopt en rechttoe rechtaan met een goed gebruik van de grammatica is essentieel bij het schrijven van elk technisch stuk. De schrijver moet ook elk technisch stuk dat geschreven wordt proeflezen en bewerken om fouten of inconsistenties met de grammatica, stijl en lay-out te corrigeren. Een technisch schrijver moet altijd in de tegenwoordige tijd schrijven, tenzij de cliënt zijn voorkeur anders aangeeft. De lezer van het technische stuk zou precies moeten doen waar jij instructies voor geeft. De schrijver moet altijd schrijven in eenvoudige zinnen die Genderneutrale zelfstandige naamwoorden bevatten. Eenvoudige zinnen helpen de lezers duidelijk en efficiënt te begrijpen welke taken ze moeten ondernemen om hun doelen te bereiken.
schrijfstijl
de schrijfstijl verschilt voor elk technisch stuk omdat het sterk afhangt van wie het publiek is en het scenario waarvoor het technisch stuk wordt geschreven. De toon van een technisch schrijfstuk is essentieel omdat het de lezer helpt te begrijpen wat voor soort toon nodig is om de taak te voltooien. Woordkeuze is ook een essentieel onderdeel van de stijl in het helpen van de behoeften voor het publiek, omdat het verbindt terug naar wie uw publiek is. Bij het verwijzen naar delen van informatie of websites is het essentieel om duidelijke en zichtbare manieren te bieden om toegang te krijgen tot de informatie met behulp van tools, zoals figuren en tabellen.
andere technische schrijftips
Doe Extra onderzoek en leer meer
als je het absolute minimum kent, krijg je misschien niet het beste technische stuk om het publiek te helpen de informatie te begrijpen. Er zou veel terminologie kunnen zijn die zowel de schrijver als de lezer misschien niet begrijpen. Als vuistregel, als je als lezer een concept of term niet begrijpt, definieer het dan. Te veel informatie kan altijd worden bezuinigd in latere reviews. Deze informatie moet worden onderzocht om te begrijpen hoe het werkt met wat de schrijver als geheel schrijft. Onderzoek een beetje vader en ontdek welke andere informatie kan worden gebruikt om het technische stuk wordt geschreven verbeteren.
word het publiek en onderschat het publiek
plaats jezelf in de schoenen van het publiek. Kun je de instructies of informatie die je voor het publiek hebt geschreven goed begrijpen en opvolgen? Zo ja, dan kunt u meer informatie geven als u denkt dat het een beetje meer hulp nodig heeft. Zo niet, je nodig hebt om de onderdelen die niet duidelijk en vind een manier om de informatie goed te verstrekken. Een groot probleem dat technische schrijvers vaak hebben is dat ze de kennis van hun publiek overschatten. Het publiek kan meerdere mensen op verschillende niveaus van kennis zijn. Het is volkomen aanvaardbaar om kort informatie te verstrekken die zou kunnen worden verondersteld of reeds als opfriscursus voor het publiek worden vermeld.
vraag om een tweede en derde advies en Peer Review
technische schrijvers zijn vindingrijk. De grootste bron die je hebt zijn je vakexperts. Zorg ervoor dat u uw KMO ‘ s vraagt of ze kennislacunes of fouten zien. Schrijvers controleren met hun klanten om te zien of er kennis hiaten of fouten die de schrijver zou kunnen over het hoofd zien. Het hebben van een supervisor of collega kijken over en geven van een mening kan ook helpen bij het verbeteren van een technisch stuk. Peer review is wanneer een groep mensen elkaar ontmoeten om te lezen, commentaar te geven en verbeteringen aan elkaars werk aan te bevelen. Meer blinde vlekken worden blootgelegd wanneer meer mensen een document beoordelen, dat nauwkeurige en beknopte informatie garandeert.
technische schrijvers leren nieuwe informatie voor elk project waaraan zij werken. De schrijvers krijgen een beter begrip van wat klanten nodig hebben, omdat ze beginnen Onder het kennisniveau van hun lezers voor alle onderzoek en discussies met de vakexperts. Dit wordt een grote troef voor bedrijven, omdat minder veronderstellingen openen voor een effectievere opleiding. De combinatie van de schrijvers leren het materiaal en deze ethische principes van technische schrijfstandaarden leiden tot meer vertrouwen en efficiënte medewerkers.