Klik hier om te helpen David McMurrey betaal zijn webhostingrekening:
Doneer elke kleine bijdrage die je kunt!
Online technisch schrijven blijft gratis.
Titelformulering
Titels van langere documenten zoals formele techdocs, gebruikershandleidingen en whitepapers zijn soms te kort. Als een techdoc-titel bijvoorbeeld "Rapport over Plasticvervuiling" zou zijn, kan het document meer dan 300 pagina's omvatten. Als het "Evaluatie van Methoden voor Recycling van Plastic" zou zijn, zou het document misschien beter beheersbaar zijn.
Natuurlijk wil je niet dat een document de titel heeft van de ene John Milton, de Engelse dichter, die het in 1641 heeft gemaakt: Van de Hervorming van de Kerkdiscipline in Engeland: En de Oorzaken die tot nu toe hebben verhinderd. Twee Boeken, Geschreven aan een Vriend.
Denk eens aan al de dingen die je over elk van deze onderwerpen zou kunnen zeggen! Belangrijk is ook het feit dat lezers uit dergelijke titels gewoon niet zullen weten wat je echt gaat behandelen.
Elementen van titelvorming
Wanneer je een titel voor je document bedenkt, overweeg dan om deze elementen aan te geven, maar zonder een titel te creëren die een alinea lang is:
- Onderwerp: Het onderwerp van uw document kan vergelijkbaar zijn met de bovenstaande voorbeelden. Maar stop daar niet—u heeft meer werk te doen.
- Reikwijdte: Omvang verwijst naar hoe breed of hoe smal je focus op het onderwerp zal zijn. Omvang en overzicht zijn niet altijd gemakkelijk te onderscheiden. Het element overzicht geeft een algemene beoordeling van een aspect van het onderwerp.
- Overzicht: Zoals de term hier wordt gebruikt, verwijst overzicht naar een opsomming van de belangrijkste subonderwerpen die behandeld zullen worden. Het is waar, het is tegenstrijdig met hoe de term wordt gebruikt om de reikwijdte te definiëren. Maak je geen zorgen—dit is geen wetenschap. Een goed voorbeeld van dit gebruik van de term is dit: Ebola: Overdracht, Symptomen, Behandeling. De laatste drie woorden zijn de opsomming.
Merk op dat het proces van het creëren van een specifieke, gerichte titel vergelijkbaar is met het proces van het verfijnen van een onderwerp, elders elders.
Voorbeelden van titelformuleringen
Overweeg deze titel: Nanotechnologie: Overzicht van Medische Toepassingen. Het gigantische onderwerp nanotechnologie is inderdaad vermeld, maar let op dat het is beperkt tot medische toepassingen en een afbakenende element is toegepast—overzicht.
Let op het gebruik van de dubbele punt in het voorgaande voorbeeld. Het maakt het mogelijk om woorden te besparen. Een andere mogelijkheid is Medische Toepassingen van Nanotechnologie: Overzicht.
Probleemtitel formulering
Een veelvoorkomend probleem met technische documenten zijn te algemene, vage titels, bijvoorbeeld:
Rapport over Nanotechnologie
Rapport over Ebola
Rapport over Smartphones
Rapport over Zonne-energie
Rapport over Grafene
Titelpagina Ontwerp en Indeling
Het hoofdstuk over technische documentatie ontwerp presenteert een nogal spartaans idee van de titelpagina, hier links weergegeven. Veel techdocs hebben echter prachtige afbeeldingen opgenomen in de titelpagina, zoals rechts getoond:
 |
 |
Ik zou uw gedachten, reacties en kritiek over dit hoofdstuk waarderen: je reactie—David McMurrey.
