Over Technische Communicatie, Cursussen, Auteurs

door David McMurrey

Technische schrijftrainingen introduceren je in enkele van de belangrijkste aspecten van schrijven in de werelden van wetenschap, technologie en zaken—met andere woorden, het soort schrijven dat wetenschappers, verpleegkundigen, artsen, computerspecialisten, overheidsfunctionarissen, ingenieurs en andere dergelijke mensen doen als onderdeel van hun reguliere werk.

Om te leren hoe je effectief kunt schrijven voor de arbeidswereld, bestudeer je veelvoorkomende typen rapporten, speciale opmaakitems zoals inleidingen en kopjes, eenvoudige technieken voor het opnemen van grafieken in rapporten, en enkele technieken voor het produceren van een professioneel uitziende eindversie.

Technische schrijfcurussen bouwen voort op wat je hebt geleerd in andere schrijfcurussen. Maar er is veel nieuws te leren! Als je momenteel een baan hebt waarin je schrijft, zul je ontdekken dat je wat je leert in je technische schrijfopleiding direct kunt toepassen.

Je vraagt je waarschijnlijk af wat dit "technisch schrijven ding" is. Iemand heeft je misschien zelfs verteld: "het is deze cursus waar ze je laten schrijven over raketwetenschap en hersenchirurgie." Nou, dat is niet echt het geval, zoals je zo zult zien. Eigenlijk is het gebied van technische communicatie essentieel in een breed scala aan velden en beroepen. Het is een volledig professioneel veld met diploma-programma's, certificeringen en ja! zelfs theorie. Het is een goed veld met veel groeipotentieel en inkomstenmogelijkheden; en een inleidende cursus technisch schrijven waarvoor dit boek is ontwikkeld, is een goede manier om te beginnen als je geïnteresseerd bent in een carrière in dit veld.

Werkplek schrijven. Echter, de focus van cursussen technisch schrijven is niet noodzakelijkerwijs een carrière als technisch schrijver, maar een introductie tot de soorten schrijfvaardigheden die je nodig hebt in praktisch elke technisch georiënteerde professionele functie. Ongeacht welk soort professioneel werk je doet, is de kans groot dat je veel moet schrijven—en veel daarvan technisch van aard is. Hoe meer je weet over enkele basisvaardigheden voor technisch schrijven, die in deze gids en in cursussen technisch schrijven worden behandeld, hoe beter je zult kunnen schrijven. En dat zal goed zijn voor de projecten waaraan je werkt, voor de organisaties waarin je werkt, en—vooral—goed voor jou en je carrière.

De betekenis van "technisch." Technische communicatie—of technisch schrijven, zoals de cursus vaak wordt genoemd—is niet het schrijven over een specifiek technisch onderwerp zoals computers, maar over elk technisch onderwerp. De term "technisch" verwijst naar kennis die niet algemeen verspreid is, die meer het terrein van experts en specialisten is. Wat uw studie ook is, u ontwikkelt een expertise—u wordt een specialist in een bepaald technisch gebied. En telkens wanneer u probeert iets over uw vakgebied te schrijven of te zeggen, bent u bezig met technische communicatie.

Belang van het publiek. Een ander belangrijk onderdeel van de definitie van technische communicatie is de ontvanger van de informatie—het publiek. Technische communicatie is de levering van technische informatie aan lezers (of luisteraars of kijkers) op een manier die is aangepast aan hun behoeften, niveau van begrip en achtergrond. Sterker nog, dit publieks-element is zo belangrijk dat het een van de hoekstenen van deze cursus is: je wordt uitgedaagd om over zeer technische onderwerpen te schrijven, maar op een manier die een beginner—een niet-specialist—zou kunnen begrijpen. Dit vermogen om technische informatie te "vertalen" naar niet-specialisten is een sleutelvaardigheid voor elke technische communicator. In een wereld van snelle technologische ontwikkeling blijven mensen voortdurend achter en worden ze technisch analfabeet. Technologiebedrijven hebben voortdurend moeite om effectieve manieren te vinden om klanten of potentiële klanten te helpen de voordelen of de werking van hun nieuwe producten te begrijpen.

Dus ontspannen! Je hoeft niet over computers of raketwetenschap te schrijven—schrijf over het gebied van technische specialisatie dat je kent of aan het leren bent. En plan om er zo over te schrijven dat zelfs opa het kan begrijpen!

Echt technische schrijfstijl. Blijf ontspannen, maar je moet weten dat professionele technische schrijvers inderdaad over zeer technische zaken schrijven—informatie die ze niet kunnen beheersen tenzij ze teruggaan voor een Ph.D. Maar wacht eens even! De technische documenten moeten binnen negen maanden met het product worden geleverd! Hoe doen ze dat? Professionele technische schrijvers vertrouwen op deze strategieën om de technische nauwkeurigheid van hun werk te waarborgen:

• Bestudering van boeken, artikelen, rapporten, websites die gerelateerd zijn aan het product
• Productspecificaties: wat het product moet doen, hoe het is ontworpen
• Interviews met vakexperts: de productspecialist, ontwikkelaars, ingenieurs
• Productvergaderingen tijdens de ontwikkelingscyclus
• Live demonstraties van het product
• Vertrouwd raken met vergelijkbare, concurrerende producten
• Experimenteren met werkmodellen van het product
• Het belangrijkste is de beoordeling door vakexperts van het werk van technische schrijvers op technische nauwkeurigheid en volledigheid.

Natuurlijk zullen ervaren technische schrijvers je vertellen dat productontwikkeling zo snel gaat dat specificaties niet altijd mogelijk zijn en dat werkende modellen van het product zelden beschikbaar zijn. Daarom is de beoordeling door de vakexperts vaak het belangrijkst.

Over Cursussen Technisch Schrijven

In technische schrijf cursussen ligt de nadruk meestal op het technische rapport, dat tegen het einde van het semester moet worden ingeleverd. Bijna alles wat je in de cursus doet, is gericht op het ontwikkelen van de vaardigheden die nodig zijn om dat rapport te produceren. Natuurlijk beginnen sommige technische schrijf cursussen met een cv en sollicitatiebrief (vaak bekend als de begeleidende brief), maar daarna plan je het technische rapport, schrijf je een voorstel waarin je voorstelt dat rapport te schrijven. Vervolgens schrijf je korte technische papers waarin je gewend raakt aan het gebruik van dingen zoals koppen, inleiding, graphics en speciale kennisgeving—om nog maar te zwijgen over het schrijven over technische onderwerpen op een duidelijke, beknopte, begrijpelijke manier die geschikt is voor een specifiek publiek.

Voorzichtigheid: Je moet je ervan bewust zijn dat cursussen technische schrijfvaardigheid schrijf-intensief zijn. Je zult waarschijnlijk meer schrijven in je cursus technische schrijfvaardigheid dan in welke andere cursus je ooit hebt gevolgd. Als je deze semester natuurkunde, calculus en tussenliggende boekhouding volgt en een baby verwacht—nou, misschien is dit niet precies het juiste semester voor technische schrijfvaardigheid.

Deze tekst is ontstaan halverwege de jaren '80 terwijl ik werkte bij IBM–in Austin, Texas, en als adjunct-docent aan Austin Community College. Met een desktop publicatiesysteem genaamd Interleaf, schreef ik dit in een tijd waarin de meeste studenten nog typemachines gebruikten. Er kunnen nog steeds restanten van deze tijd in deze pagina's staan. In 1994 ontdekte ik het web en begon een dolle sprint tijdens mijn lunchuren om de Interleaf-bestanden naar HTML te converteren met behulp van talrijke macro's die ik in Emacs had gemaakt. In 2014 begon ik deze tekst grondig te herzien en te moderniseren. Sommige voorbeelden stammen uit mijn tijd als docent technisch schrijven in de vroege jaren '80 aan de Universiteit van Texas. Ze zijn verouderd maar goede voorbeelden. Lezers worden aangemoedigd om me updates te sturen! — David

Lees over de auteur van dit online leerboek.