Klik hier om te helpen David McMurrey betaal voor webhosting:
Doneer elk klein bedrag dat je kunt!
Online technisch schrijven blijft gratis.
Het publiek van een technisch document—of enig geschreven stuk voor dat zijn—de beoogde of potentiële lezer of lezers. Voor de meeste technische schrijvers is dit het belangrijkste overweging bij het plannen, schrijven en beoordelen van een document. Je "past" je schrijfwerk aan om te voldoen aan de behoeften, interesses en achtergrond van de lezers die jouw tekst zullen lezen.
Het principe lijkt absurd eenvoudig en voor de hand liggend. Het is veel hetzelfde als iemand te vertellen, "Praat zodat de persoon voor je begrijpt wat je zegt." Het is alsof je zegt, "Praat geen raketwetenschap tegen je zesjarige." Hebben we daar een cursus voor nodig? Het lijkt er niet op. Maar in feite is het gebrek aan publieksanalyse en aanpassing een van de oorzaken van de meeste problemen die je tegenkomt in professionele, technische documenten—met name instructies waar het het meest opvallend naar voren komt.
Notities:
- Zodra je de sectie over doelgroepen hebt gelezen, probeer dan de publieksplanner. Je vult de lege plekken in met antwoorden op gedetailleerde vragen over je publiek en vervolgens e-mail je het naar jezelf en, indien gewenst, naar je instructeur.
- Ook bevat dit hoofdstuk een sectie over situatie. Probeer de situatie planner om een idee te ontwikkelen van de situatie waarin uw publiek zich bevindt.
Een van de eerste dingen die je moet doen wanneer je een publiek analyseert, is het type (of types— het is zelden maar één type) te identificeren. De gebruikelijke indeling van publieken in categorieën is als volgt:
- Deskundigen: Dit zijn de mensen die de theorie en het product van binnen en van buiten kennen. Ze hebben het ontworpen, ze hebben het getest, ze weten alles ervan. Vaak hebben ze gevorderde graden en werken ze in academische omgevingen of in de onderzoeks- en ontwikkelingsgebieden van de overheid en de technologiewereld. De niet-specialistische lezer heeft de minste kans om te begrijpen wat deze mensen zeggen—maar heeft ook de minste reden om het te proberen. Vaker is de communicatiet uitdaging waar de expert mee te maken heeft, het communiceren naar de technicus en de executive.
- Technici: Dit zijn de mensen die de dingen bouwen, bedienen, onderhouden en repareren waar de experts over ontwerpen en theoriseren. Hun kennis is ook zeer technisch, maar van een meer praktische aard.
- Executives: Dit zijn de mensen die zakelijke, economische, administratieve, juridische, overheids- en politieke beslissingen nemen over de zaken waar de experts en technici mee werken. Als het om een nieuw product gaat, beslissen zij of het geproduceerd en op de markt gebracht moet worden. Als het om een nieuwe energie technologie gaat, beslissen zij of de stad het zou moeten implementeren. Het is waarschijnlijk dat leidinggevenden even min technische kennis over het onderwerp hebben als niet-specialisten.
- Niet-specialisten: Deze lezers hebben de minste technische kennis van allemaal. Hun interesse kan net zo praktisch zijn als die van technici, maar op een andere manier. Ze willen de nieuwe krachttechnologie genoeg begrijpen om te weten of ze ervoor of ertegen moeten stemmen bij de aankomende obligaties verkiezing. Of ze zijn gewoon nieuwsgierig naar een specifiek technisch onderwerp en willen daarover leren—maar om geen specifieke, praktische reden.
Publieksanalyse
Het is belangrijk om te bepalen tot welke van de vier net besproken categorieën de potentiële lezers van uw document behoren, maar dat is nog niet het einde. Doelgroepen, ongeacht de categorie, moeten ook worden geanalyseerd op basis van kenmerken zoals de volgende:
- Achtergrond__ENTITEIT_0__kennis, ervaring, opleiding: Een van uw belangrijkste zorgen is hoeveel kennis, ervaring of training u kunt verwachten van uw lezers. Als u verwacht dat sommige van uw lezers bepaalde achtergrond missen, levert u die informatie dan automatisch in uw document? Overweeg een voorbeeld: stel dat u een gids schrijft voor het gebruik van een softwareproduct dat draait onder Microsoft Windows. Hoeveel kunt u verwachten dat uw lezers weten over Windows? Als sommige waarschijnlijk weinig over Windows weten, moet u die informatie dan aanbieden? Als u nee zegt, loopt u het risico dat klanten gefrustreerd raken over uw product. Als u ja zegt tegen het toevoegen van achtergrondinformatie over Windows, vergroot u uw werklast en voegt u toe aan het aantal pagina's van het document (en dus aan de kosten). Het is duidelijk dat er geen gemakkelijke antwoord op deze vraag is; een deel van het antwoord kan hangen van hoe klein een segment van het publiek die achtergrondinformatie nodig heeft.
- Behoeften en interesses: Om je document te plannen, moet je weten wat je publiek van dat document zal verwachten. Stel je voor hoe lezers je document willen gebruiken; wat zullen ze ervan eisen? Bijvoorbeeld, stel je voor dat je een handleiding schrijft over hoe je een nieuwe smartphone — moet gebruiken; wat zullen je lezers daarin verwachten te vinden? Stel je voor dat je onder contract staat om een achtergrondrapport over klimaatverandering te schrijven voor een nationale vastgoedvereniging —; waar willen zij over lezen; en, even belangrijk, wat willen ze niet Waar wilt u over lezen?
- Verschillende culturen: Als je schrijft voor een internationaal publiek, wees je dan bewust dat de formats voor het aangeven van tijd en data, geldbedragen en numerieke hoeveelheden wereldwijd variëren. Wees ook bekent dat humor en figuurlijke taal (zoals in "een homerun slaan") waarschijnlijk niet buiten onze eigen cultuur worden begrepen. Texas A&M University stelt beschikbaar Hoofdstuk 6, "Schrijven voor Internationale Lezers," van Technische Informatie Rapporteren, Elizabeth Tebeaux, et al. Voor normen, zie Lijst van stijlgidsen van Wikipedia. (Dank aan de anonieme gast die deze belangrijke ideeën heeft bijgedragen.)
- Andere demografische kenmerken: En natuurlijk zijn er nog veel andere kenmerken van je lezers die misschien heb invloed op hoe je je document—moet ontwerpen en schrijven, bijvoorbeeld leeftijdsgroepen, type woning, woongebied, geslacht, politieke voorkeuren, enzovoort.
Publieksanalyse kan worden gecompliceerd door minstens twee andere factoren: gemengde publiektype voor één document, grote variabiliteit binnen het publiek, en onbekende publieken.
- Meer dan één publiek. Je zult waarschijnlijk ontdekken dat je document voor meer dan één publiek is. Bijvoorbeeld, het kan worden bekeken door technische mensen (experts en technici) en administratieve mensen (executives). Wat te doen? Je kunt alle secties zo schrijven dat alle doelgroepen van je document ze kunnen begrijpen (veel succes!). Of je kunt elke sectie strikt schrijven voor het publiek dat erin geïnteresseerd zou zijn, en vervolgens koppen en sectie-inleidingen gebruiken om je publiek te waarschuwen waar ze naartoe moeten gaan en wat ze moeten vermijden in je document.
- Grote variabiliteit in een publiek. Je kunt je realiseren dat, hoewel je een publiek hebt dat in slechts één categorie past, er een grote variabiliteit in de achtergrond is. Dit is een moeilijke situatie—als je schrijft voor de laagste gemene deler van lezers, eindig je waarschijnlijk met een omslachtig, saai boekachtig iets dat de meeste lezers zal afschrikken. Maar als je niet op dat laagste niveau schrijft, verlies je dat segment van je lezers. Wat te doen? De meeste schrijvers kiezen voor de meerderheid van de lezers en offeren die minderheid op die meer hulp nodig heeft. Anderen plaatsen de aanvullende informatie in bijlagen of voegen kruisverwijzingen naar boeken voor beginners toe.
Publieksanalyse Voorbeeld
Als je een cursus technisch schrijven volgt, kun je worden verwacht een publiekbeschrijving aan je technische documenten toe te voegen. Hier is een voorbeeld:
| Opmerking voor de instructeur: Deze instructies zijn bedoeld voor individuen die hun berekeningen willen stroomlijnen met behulp van Microsoft Excel door gebruik te maken van macro's om hun gegevens efficiënt te berekenen. Ze begrijpen hoe ze gegevens in Microsoft Excel moeten invoeren en hebben basiskennis van de Microsoft Office Suite. Ze zijn vertrouwd met Windows-software en hebben voldoende basisrekenvaardigheden om hun berekeningen te verifiëren en te controleren op logische fouten bij het rekenen. |
Publieksaanpassing
Oké! Dus je hebt je publiek geanalyseerd totdat je ze beter kent dan jezelf. Wat heb je daar aan? Hoe gebruik je deze informatie? Hoe voorkom je dat je iets schrijft dat nog steeds onbegrijpelijk of nutteloos is voor je lezers?
De kunst van het schrijven aan je publiek kan veel te maken hebben met aangeboren talent, intuïtie en zelfs mysterie. Maar er zijn enkele controles die je kunt gebruiken om een betere kans te hebben om verbinding te maken met je lezers. De volgende "controles" hebben voornamelijk te maken met het begrijpelijker maken van technische informatie voor niet-specialistische doelgroepen:
- Voeg informatie toe die lezers nodig hebben om uw document te begrijpen. Controleer of bepaalde belangrijke informatie ontbreekt—bijvoorbeeld een kritieke reeks stappen uit een set instructies; belangrijke achtergrond die beginners helpt de hoofddiscussie te begrijpen; definitie van sleuteltermen. (Zie het hoofdstuk over ideeën voor inhoud voor details.)
- Laat informatie weg die uw lezers niet nodig hebben. Onnodige informatie kan ook lezers verwarren en frustreren—ten slotte is het er zodat ze zich verplicht voelen om het te lezen. Bijvoorbeeld, je kunt waarschijnlijk de theoretische discussie uit de basisinstructies wegsnijden.
- Verander het niveau van de informatie die je momenteel hebt. Je hebt misschien de juiste informatie, maar deze kan "te hoog" of te laag technisch niveau zijn. Het kan gericht zijn op de verkeerde soort publiek—, bijvoorbeeld op een expert publiek in plaats van op een technisch publiek. Dit gebeurt het vaakst wanneer productontwerpnummers worden doorgegeven als instructies.
- Voeg voorbeelden toe om lezers te helpen begrijpen. Voorbeelden zijn een van de krachtigste manieren om verbinding te maken met doelgroepen, vooral in instructies. Zelfs in niet-instructieve tekst, bijvoorbeeld wanneer je een technisch concept probeert uit te leggen, zijn voorbeelden een grote hulp—analogieën in het bijzonder.
- Verander het niveau van je voorbeelden. U gebruikt misschien voorbeelden, maar de technische inhoud of het niveau is misschien niet geschikt voor uw lezers. Eenvoudige voorbeelden zijn mogelijk niet nuttig voor experts; zeer technische voorbeelden kunnen volledig aan uw niet-specialistische lezers voorbijgaan.
- Verander de organisatie van uw informatie. Soms heb je alle juiste informatie, maar rangschik je deze op de verkeerde manier. Bijvoorbeeld, er kan te veel achtergrondinformatie vooraf zijn (of te weinig), waardoor bepaalde lezers verdwaald raken. Soms moet achtergrondinformatie worden samengevoegd met de hoofdinhoud—bijvoorbeeld, in instructies is het soms beter om achtergrond in stukjes te geven op de plaatsen waar deze direct nodig is. (Zie de hoofdstukken over structuur en organisatie van informatie in een document.)
- Versterk overgangen. Het kan moeilijk zijn voor lezers, met name niet-specialisten, om de verbanden te zien tussen de hoofdsecties van uw document, tussen individuele paragrafen en soms zelfs tussen individuele zinnen. U kunt deze verbanden veel duidelijker maken door toevoeging van overgangswoorden en door te echoën sleutelwoorden meer nauwkeurig. Woorden zoals "dus," "bijvoorbeeld," "echter" zijn overgangswoorden—ze geven de logica aan die de vorige gedachte verbindt met de komende gedachte. Je kunt overgangen ook versterken door zorgvuldig dezelfde sleutelwoorden te herhalen. In technische proza is het niet een goed idee om woordkeuze te variëren—dezelfde woorden te gebruiken zodat mensen niet meer in de war raken dan ze misschien al zijn. (Zie het hoofdstuk over overgangen.)
- Schrijf sterkere inleidingen — zowel voor het hele document als voor belangrijke secties. Mensen lijken met meer zelfvertrouwen en begrip te lezen wanneer ze het "grote geheel"—een overzicht hebben van wat komen gaat, en hoe het zich verhoudt tot wat ze net hebben gelezen. Zorg er daarom voor dat je een sterke inleiding hebt voor het hele document—een die duidelijk het onderwerp, doel, publiek en de inhoud van dat document maakt. En voor elke hoofdsectie binnen je document, gebruik mini-inleidingen die ten minste het onderwerp van de sectie aangeven en een overzicht geven van de subonderwerpen die in die sectie worden behandeld. (Zie het hoofdstuk over introducties zowel voor volledige rapporten als voor secties binnen rapporten.)
- Maak thematische zinnen voor paragrafen en paragraafgroepen. Het kan lezers enorm helpen om ze een idee te geven van het onderwerp en het doel van een sectie (een groep alinea's) en in het bijzonder om ze een overzicht te geven van de subonderwerpen die aan bod gaan komen. Routekaarten helpen wanneer je in een andere staat bent! (Zie het hoofdstuk over gebruik makend van samenvattingen en onderwerpzinnen.)
- Verander de stijl en lengte van de zin. Hoe je — schrijft op het individuele zin-niveau — kan ook een groot verschil maken. In instructies, bijvoorbeeld, is het gebruik van de gebiedende wijs en "jij" formuleringen veel begrijpelijker dan de passieve vorm of de derde persoon. Om de een of andere reden kan het personaliseren van je schrijfstijl en het meer ontspannen en informeel maken het toegankelijker en begrijpelijker maken. Passieve, persoonsloze teksten zijn moeilijker te lezen — zet mensen en actie in je schrijven. Evenzo, kies voor actieve werkwoorden in plaats van zijn werkwoordformuleringen. Dit alles maakt je schrijven directer en immediater—lezers hoeven er niet voor te graven. (Zie het hoofdstuk over algemene problemen met zinnenstijl voor details.)
En uiteraard doet de lengte van zinnen er ook toe. Een gemiddelde van ergens tussen de 15 en 25 woorden per zin is ongeveer goed; zinnen van meer dan 30 woorden zijn om te wantrouwen. - Werk aan de duidelijkheid en beknoptheid van zinnen. Dit is nauw verwant aan de vorige "controle" maar verdient zijn eigen plek. Vaak kan de schrijfstijl zo omslachtig zijn dat het moeilijk of frustrerend is om te lezen. Wanneer je je ruwe versies herschrijft, geef ze dan een dieet—ga door een versie regel voor regel en probeer het totale aantal woorden, pagina's of regels met 20 procent te verminderen. Probeer het als een experiment en kijk hoe je het doet. Je zult veel vervelende, onnodige details en opgeblazen zinsconstructies vinden die je kunt schrappen. (Zie het hoofdstuk over veelvoorkomende problemen met zinsstructuur en duidelijkheid voor details.)
- Gebruik meer of andere grafische elementen. Voor niet-specialistische doelgroepen wilt u misschien meer graphics—en eenvoudigere graphics gebruiken. Graphics voor specialisten zijn gedetailleerder en technischer. In technische documenten voor niet-specialisten zijn er ook vaak meer "decoratieve"graphics—die aantrekkelijk zijn maar helemaal geen strikte informatieve of overtuigende functie hebben. (Zie het hoofdstuk over grafieken voor details.)
- Verdeel tekst in zinvolle, bruikbare stukken of voeg tekst samen. Voor niet-specialistische lezers is het wellicht nodig om kortere paragrafen te hebben. Misschien is een paragraaf van 6 tot 8 regels de gebruikelijke maximumlengte. Let op hoe veel langer paragrafen zijn in technische documenten die voor specialisten zijn geschreven.
- Voeg kruisverwijzingen toe naar belangrijke informatie. In technische informatie kun je niet-specialistische lezers helpen door hen naar achtergrondbronnen te verwijzen. Als je een onderwerp niet volledig ter plekke kunt uitleggen, verwijs dan naar een sectie of hoofdstuk waar het behandeld wordt. (Zie het hoofdstuk over kruisverwijzingen voor details.)
- Gebruik koppen en lijsten. Lezers kunnen geïntimideerd worden door grote, dichte paragrafen, die alleen door een lege regel nu en dan onderbroken worden. Zoek in je ruwe versies naar manieren om koppen in te voegen—zoek naar veranderingen in onderwerp of subonderwerp. Zoek in je tekst naar lijsten van dingen—deze kunnen worden omgevormd tot verticale lijsten. Zoek naar gekoppelde lijsten zoals termen en hun definities—deze kunnen worden omgevormd tot twee-koloms lijsten. Wees natuurlijk voorzichtig om deze speciale opmaak niet te forceren—overdrijf het niet. (Zie de hoofdstukken over koppen en lijsten voor details.)
- Gebruik speciale typografie en werk met marges, regellengte, regelafstand, lettergrootte en letterstijl. Voor niet-specialistische lezers kun je dingen doen zoals de regels korter maken (de marges verkleinen), grotere lettergroottes gebruiken en dergelijke tactieken. Bepaalde letterstijlen worden verondersteld vriendelijker en leesbaarder te zijn dan andere. (Probeer iemand in de uitgeverij te vinden voor inzichten over lettertypen.)
Dit zijn de soorten "controles" die professionele technische schrijvers gebruiken om hun werk te verfijnen en het zo begrijpelijk mogelijk te maken. En in tegenstelling tot dat, is het de accumulatie van veel problemen in deze gebieden—zelfs ogenschijnlijk triviale— die ervoor zorgt dat een document moeilijk te lezen en begrijpen is. Niet-professionals vragen zich vaak af waarom professionele schrijvers en redacteuren zich bezighouden met zulke ogenschijnlijk kieskeurige, triviale, kleine details in het schrijven—maar ze tellen allemaal op! Het doet me denken aan de oude Chinese executiemethode genaamd "dood door duizend sneden." In dit geval zou het echter "verbijstering door duizend kleine problemen." zijn.
Situatieanalyse & Uitvinding
Het is niet genoeg om alleen een onderwerp te kiezen en een doelgroep te definiëren voor een technisch schrijfproject. Je moet weten (of uitvinden) de situatie waarin dit publiek opereert — wat de doelen zijn: een probleem oplossen, verbetering mogelijk maken, ondersteuning bieden bij besluitvorming? Situaties voor het schrijven van technische documentatie zijn waarschijnlijk net zo oneindig als menselijke sociale relaties. Een situatie voor technische documentatie houdt een publiek in dat een bepaald type technische documentatie nodig heeft of aanvraagt voor specifieke behoeften en gebruiken. Voor details, zie Situatieanalyse & Uitvinding
Gerelateerde Informatie
Gebruik van enquêtes om inzicht in het publiek te verkrijgen. BrightTalk
Publiek. Universiteit van North Carolina in Chapel Hill
Ik zou uw gedachten, reacties en kritiek over dit hoofdstuk op prijs stellen: jouw reactie—David McMurrey
