Klik hier om te helpen David McMurrey betaal voor webhosting:
Doneer elk klein bedrag dat je kunt!
Online technische schrijving blijft gratis.
Het publiek van een technisch document—of een ander stuk schrijven voor dat geval—is de bedoelde of potentiële lezer of lezers. Voor de meeste technische schrijvers is dit het belangrijkste overweging in de planning, het schrijven en het beoordelen van een document. Je "past" je schrijven aan om te voldoen aan de behoeften, interesses en achtergrond van de lezers die je tekst zullen lezen.
Het principe lijkt absurd eenvoudig en vanzelfsprekend. Het is veel hetzelfde als iemand te vertellen, "Praat zodat de persoon voor jou begrijpt wat je zegt." Het is alsof je zegt, "Praat geen raketwetenschap tegen je zesjarige." Hebben we daar een cursus voor nodig? Dat lijkt niet zo. Maar, in feite is het gebrek aan publiekanalyse en aanpassing een van de hoofdoorzaken van de meeste problemen die je tegenkomt in professionele, technische documenten—bijzonder instructies waar het het duidelijkst 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 e-mailt het naar jezelf en, indien gewenst, naar je instructeur.
- Ook bevat dit hoofdstuk een sectie over situatie. Probeer de situatieplanner om een idee te ontwikkelen van de situatie waarin je publiek zich bevindt.
Een van de eerste dingen die je moet doen wanneer je een publiek analyseert, is het type (of types—identificeren; het is zelden maar één type). 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. Zij hebben het ontworpen, zij hebben het getest, zij weten alles ervan. Vaak hebben zij gevorderde graden en werken zij in academische omgevingen of in onderzoeks- en ontwikkelingsgebieden van de overheid en de technologie. De niet-gespecialiseerde lezer is het minst geneigd te begrijpen wat deze mensen zeggen—maar heeft ook de minste reden om het te proberen. Vaak is de communicatietop die de expert tegenkomt, het communiceren met de technicus en de bestuurder.
- Technici: Dit zijn de mensen die de spullen bouwen, bedienen, onderhouden en repareren waar de experts over ontwerpen en theorien. Hun kennis is ook zeer technisch, maar van een meer praktische aard.
- Executives: Dit zijn de mensen die zakelijke, economische, administratieve, juridische, regering, politieke beslissingen nemen over de zaken waar de experts en technici mee werken. Als het een nieuw product is, beslissen zij of het geproduceerd en op de markt gebracht moet worden. Als het een nieuwe krachttechnologie is, beslissen zij of de stad het moet implementeren. Leidinggevenden hebben waarschijnlijk net zo weinig technische kennis over het onderwerp 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 in de aankomende obligatieverkiezingen. Of ze zijn gewoon nieuwsgierig naar een specifieke technische kwestie en willen erover leren—maar zonder specifieke, praktische reden.
Publieksanalyse
Het is belangrijk om te bepalen tot welke van de vier net besproken categorieën de potentiële lezers van jouw document behoren, maar dat is nog niet het einde. Publieken, ongeacht de categorie, moeten ook worden geanalyseerd op basis van kenmerken zoals de volgende:
- Achtergrond__ENTITEIT_0__kennis, ervaring, training: 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, biedt u die informatie dan automatisch aan in uw document? Overweeg een voorbeeld: stel je voor dat je een handleiding 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 van Windows weten, moet u die informatie dan verstrekken? 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, verhoogt u uw werkinspanning en voegt u toe aan het aantal pagina's van het document (en dus aan de kosten). Het is duidelijk dat er geen gemakkelijke antwoorden zijn op deze vraag; een deel van het antwoord kan betrekking hebben op hoe klein een segment van het publiek die achtergrondinformatie nodig heeft.
- Behoeften en interesses: Om uw document te plannen, moet u weten wat uw publiek van dat document verwacht. Stel je voor hoe lezers uw document willen gebruiken; wat zullen ze er van eisen. Bijvoorbeeld, stel je voor dat je een handleiding schrijft over hoe je een nieuwe smartphone moet gebruiken—wat gaan je lezers verwachten te vinden? Stel je voor dat je onder contract staat om een achtergrondrapport over globale opwarming te schrijven voor een nationale vastgoedvereniging—waar willen zij over lezen; en, even belangrijk, wat willen ze niet Waar wil je over lezen?
- Verschillende culturen: Als je schrijft voor een internationaal publiek, wees je er dan van bewust dat de formats voor het aangeven van tijd en data, monetaire bedragen en numerieke waarden wereldwijd verschillen. Wees ook bewust van het feit dat humor en figuurlijke taal (zoals in "een homerun slaan") waarschijnlijk niet begrepen worden buiten onze eigen cultuur. 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 uit Wikipedia. (Bedankt 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 might heb invloed op hoe je jouw document—moet ontwerpen en schrijven, bijvoorbeeld leeftijdsgroepen, type woning, woongebied, geslacht, politieke voorkeuren, enzovoort.
Publieksanalyse kan complicaties met zich meebrengen door minstens twee andere factoren: gemengde publiekaantypes 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 (uitvoerders). Wat te doen? Je kunt alle secties zo schrijven dat alle doelgroepen van je document ze kunnen begrijpen (succes!). Of je kunt elke sectie strikt schrijven voor het publiek dat daarin geïnteresseerd is, en dan koppen en sectie-introducties 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 zijn achtergrond is. Dit is een lastige— als je schrijft voor de laagste gemene deler van lezers, ben je waarschijnlijk op weg naar een onhandig, saaierig boekachtig iets dat de meerderheid van de 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 beginnersboeken toe.
Publieksanalyse Voorbeeld
Als je een cursus technisch schrijven volgt, kan van je verwacht worden dat je een doelgroepbeschrijving toevoegt aan je technische documenten. Hier is een voorbeeld:
| Opmerking voor de instructeur: Deze instructies zijn bedoeld voor individuen die hun berekeningen willen stroomlijnen met Microsoft Excel door middel 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 het gebruik van Windows-software en zijn comfortabel met basisrekenvaardigheden om hun berekeningen te verifiëren en op logische fouten in de berekeningen te controleren. |
Doelgroepadaptatie
Okay! Dus je hebt je publiek geanalyseerd totdat je ze beter kent dan jezelf. Wat heeft dat voor nut? Hoe gebruik je deze informatie? Hoe voorkom je dat je iets schrijft dat nog steeds onbegrijpelijk of nutteloos is voor je lezers?
Het vak van schrijven naar 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 contact 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 essentiële informatie ontbreekt—bijvoorbeeld een kritieke reeks stappen uit een set instructies; belangrijke achtergrondinformatie die beginners helpt de hoofd discussie te begrijpen; definitie van sleuteltermen. (Zie het hoofdstuk over ideeën voor inhoud voor details.)
- Laat informatie weg die je lezers niet nodig hebben. Onnodige informatie kan lezers ook verwarren en frustreren—ten slotte is het er zodat ze zich verplicht voelen om het te lezen. Je kunt bijvoorbeeld waarschijnlijk de theoretische discussie uit de basisinstructies verwijderen.
- Verander het niveau van de informatie die je momenteel hebt. U heeft misschien de juiste informatie, maar deze kan "te hoog" of te laag technisch niveau zijn gepresenteerd. Het kan gericht zijn op het verkeerde soort publiek—bijvoorbeeld, op een deskundig publiek in plaats van op een technisch publiek. Dit gebeurt het vaakst wanneer productontwerpnoto's doorgegeven worden als instructies.
- Voeg voorbeelden toe om lezers te helpen begrijpen. Voorbeelden zijn een van de krachtigste manieren om verbinding te maken met publiek, vooral in instructies. Zelfs in niet-instructionele teksten, bijvoorbeeld als je een technisch concept probeert uit te leggen, zijn voorbeelden een grote hulp—analogieën in het bijzonder.
- Verander het niveau van je voorbeelden. Je gebruikt misschien voorbeelden, maar de technische inhoud of het niveau is mogelijk niet geschikt voor je lezers. Eenvoudige voorbeelden zijn misschien niet nuttig voor experts; zeer technische voorbeelden kunnen totaal niet aansluiten bij je niet-specialistische lezers.
- Verander de organisatie van je informatie. Soms heb je alle juiste informatie, maar rangschik je deze op de verkeerde manier. Bijvoorbeeld, er kan te veel achtergrondinformatie vooraan zijn (of te weinig) waardoor bepaalde lezers de weg kwijtraken. Soms moet achtergrondinformatie worden samengevoegd met de hoofd informatie—bijvoorbeeld, in instructies is het soms beter om chunks achtergrondinformatie te geven op de plekken waar ze onmiddellijk nodig zijn. (Zie de hoofdstukken over structuur en organisatie van informatie in een document.)
- Versterk overgangen. Het kan moeilijk zijn voor lezers, vooral niet-specialisten, om de verbanden tussen de hoofdsecties van uw document, tussen individuele paragrafen en soms zelfs tussen individuele zinnen te zien. U kunt deze verbindingen veel duidelijker maken door toe te voegen overgangswoorden en door weer te geven sleutelwoorden nauwkeuriger. Woorden zoals "daarom," "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 kernwoorden 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 de belangrijkste secties. Mensen lijken met meer vertrouwen en begrip te lezen wanneer ze het "grote geheel"—zicht hebben op wat er komen gaat, en hoe het zich verhoudt tot wat ze net gelezen hebben. Zorg er daarom voor dat je een sterke inleiding hebt voor het hele document—één die duidelijk het onderwerp, de doelstelling, het publiek en de inhoud van dat document aangeeft. En voor elke belangrijke sectie 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 behandeld zullen worden. (Zie het hoofdstuk over introducties zowel voor volledige rapporten als voor secties binnen rapporten.)
- Maak onderwerpzinnen voor alinea's en alineagroepen. Het kan lezers enorm helpen om hen een idee te geven van het onderwerp en doel van een sectie (een groep paragrafen) en in het bijzonder om hen een overzicht te geven van de subonderwerpen die behandeld gaan worden. Routekaarten helpen wanneer je in een andere staat bent! (Zie het hoofdstuk over het gebruik van overzichten en onderwerpzinnen.)
- Verander de stijl en lengte van de zin. Hoe je — op het niveau van individuele zinnen schrijft, — kan ook een groot verschil maken. In instructies, bijvoorbeeld, is het gebruik van de gebiedende wijs en " je " formuleringen veel begrijpelijker dan de passieve stem of formuleringen in 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. Passief, persoonloos schrijven is moeilijker te lezen; — zet mensen en actie in je schrijven. Evenzo, kies voor actieve werkwoorden in plaats van wees werkwoordformulering. Dit maakt je schrijven directer en immediater — lezers hoeven niet te graven om het te vinden. (Zie het hoofdstuk over veelvoorkomende zinnen-stijlproblemen voor details.)
En natuurlijk is de lengte van zinnen ook belangrijk. Een gemiddelde van ergens tussen de 15 en 25 woorden per zin is ongeveer goed; zinnen van meer dan 30 woorden zijn niet te vertrouwen. - 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 overvloedig zijn dat het moeilijk of frustrerend is om te lezen. Wanneer je je ruwe concepten herzien, zet ze op een dieet—ga lijn voor lijn door een ontwerp om het totale aantal woorden, pagina's of regels met 20 procent te verminderen. Probeer het als een experiment en kijk hoe het je vergaat. Je zult veel fletse, onnodige details en opgeblazen bewoordingen vinden die je kunt wegsnijden. (Zie het hoofdstuk over veelvoorkomende zinsstructuur- en duidelijkheidsproblemen voor details.)
- Gebruik meer of andere graphics. Voor niet-specialistische doelgroepen wil je misschien meer grafieken— en eenvoudigere daarbij gebruiken. Grafieken voor specialisten zijn gedetailleerder en technischer. In technische documenten voor niet-specialisten zijn er ook vaak meer "decoratieve" grafieken— die aantrekkelijk zijn, maar absoluut geen strikte informatieve of overtuigende functie hebben. (Zie het hoofdstuk over graphics voor details.)
- Verdeel de tekst in significante, bruikbare stukken of voeg tekst samen. Voor niet-specialistische lezers is het misschien nodig om kortere paragrafen te hebben. Misschien is een paragraaf van 6 tot 8 regels de gebruikelijke maximum. Let op hoe veel langer paragrafen zijn in technische documenten geschreven voor specialisten.
- Voeg kruisreferenties toe naar belangrijke informatie. In technische informatie kun je niet-specialistische lezers helpen door hen naar achtergrondbronnen te wijzen. Als je een onderwerp niet ter plekke volledig kunt uitleggen, verwijs dan naar een sectie of hoofdstuk waar dit wel het geval is. (Zie het hoofdstuk over kruisverwijzingen voor details.)
- Gebruik koppen en lijsten. Lezers kunnen geïntimideerd worden door grote, dikke paragrafen tekst, die alleen afgebroken worden door af en toe een lege regel. Zoek in je ruwe versies naar manieren om koppen op te nemen—zoek naar veranderingen in onderwerp of subonderwerp. Zoek in je schrijven naar opsommingen van dingen—deze kunnen in verticale lijsten worden gemaakt. Zoek naar gepaard opgestelde lijsten zoals termen en hun definities—deze kunnen in twee kolommen worden gezet. 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, regel lengte, regelafstand, lettergrootte, en lettertype. Voor niet-specialistische lezers kun je dingen doen zoals de regels korter maken (de marges verkleinen), grotere lettergroottes gebruiken en andere dergelijke tactieken. Bepaalde letterstijlen worden verondersteld vriendelijker en leesbaarder te zijn dan andere. (Probeer iemand die met publiceren te maken heeft te vinden om wat inzichten over lettertypen te krijgen.)
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 op deze gebieden—zelfs schijnbaar triviale— die ervoor zorgt dat een document moeilijk te lezen en te begrijpen is. Niet-professionals vragen vaak waarom professionele schrijvers en redacteuren vasthouden aan zulke schijnbaar kieskeurige, triviale, onbelangrijke details in het schrijven—maar ze tellen allemaal op! Het doet me denken aan de oude Chinese executiemethode die "de dood door duizend sneden"wordt genoemd. Echter, in dit geval zou het "verwarring door duizend kleine problemen"zijn.
Situatieanalyse & Uitvinding
Het is niet genoeg om alleen een onderwerp te kiezen en een publiek te definiëren voor een technisch schrijfproject. Je moet weten (of uitvinden) de situatie waarbinnen dit publiek opereert—wat de doelen zijn: een probleem oplossen, verbetering mogelijk maken, besluitvorming ondersteunen? Situaties voor techdoc schrijven zijn waarschijnlijk net zo oneindig als menselijke sociale relaties. Een techdoc-situatie houdt in dat een publiek een bepaald type techdoc nodig heeft of aanvraagt voor zijn specifieke behoeften en gebruik. Voor details, zie Situatieanalyse & Uitvinding
Gerelateerde Informatie
Leesquiz. Gebruik deze quiz om je begrip van dit hoofdstuk te testen.
Training beschikbaar. Oefen met schrijven met McMurrey als uw instructeur.
Enquêtes gebruiken om inzichten over het publiek te onthullen. BrightTalk
Publiek. Universiteit van North Carolina in Chapel Hill
Ik zou uw gedachten, reacties en kritiek met betrekking tot dit hoofdstuk op prijs stellen: je reactie—David McMurrey
