Klik hier om te helpen David McMurrey betaal zijn webhostingrekening:
Doneer elk klein bedrag dat je kunt!
Online technische documentatie blijft gratis.
Titel Formulering
Titels van langere documenten zoals formele technische documenten, gebruikershandleidingen en whitepapers zijn soms te kort. Bijvoorbeeld, als de titel van een technisch document "Verslag over Plasticvervuiling" zou zijn, dan kan het document meer dan 300 pagina's beslaan. Als het "Evaluatie van Methoden voor het Recyclen van Plastic" zou zijn, kan het document beter beheersbaar zijn.
Natuurlijk wil je niet dat een document de titel heeft van die welke John Milton, de Engelse dichter, in 1641 heeft gemaakt: Van de Hervorming van de Kerkdiscipline in Engeland: En de Oorzaken die tot nu toe hebben gehinderd. Twee Boeken, Geschreven aan een Vriend.
Denk alleen maar aan al die dingen die je over elk van deze onderwerpen zou kunnen zeggen! Belangrijk is ook dat lezers uit zulke titels niet zullen weten wat je echt gaat bespreken.
Elementen van titelformulering
Wanneer je een titel voor je document maakt, overweeg dan om deze elementen aan te geven, maar zonder een titel te creëren die een paragraaf lang is:
- Onderwerp: Het onderwerp van je document kan vergelijkbaar zijn met die voorbeelden hierboven. Maar stop daar niet—je hebt meer werk te doen.
- Omvang: Reikwijdte verwijst naar hoe breed of hoe smal je focus zal zijn op het onderwerp. Reikwijdte en overzicht zijn niet altijd gemakkelijk te onderscheiden. Het element overzicht geeft een algemeen overzicht van een aspect van het onderwerp.
- Overzicht: In de context die hier wordt gebruikt, verwijst overzicht naar een opsomming van de belangrijkste subonderwerpen die behandeld moeten worden. Het is waar dat dit tegenstrijdig is met hoe de term wordt gebruikt om de reikwijdte te definiëren. Maak je geen zorgen—dit is geen wetenschap. Een goed voorbeeld van deze gebruikswijze van de term is dit: Ebola: Overdracht, Symptomen, Behandeling. De laatste drie woorden zijn de specificatie.
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 reuzenonderwerp nanotechnologie is inderdaad vermeld, maar let op dat het is beperkt tot medische toepassingen en een afbakenings-element is toegepast—overzicht.
Let op het gebruik van de dubbelepunt in het voorgaande voorbeeld. Het stelt je in staat om woorden te reduceren. Een andere mogelijkheid is Medische Toepassingen van Nanotechnologie: Overzicht.
Probleem titel formulering
Een veelvoorkomend probleem met technische documenten is dat ze te algemene, vage titels hebben, bijvoorbeeld:
Rapport over Nanotechnologie
Rapport over Ebola
Rapport over Smartphones
Rapport over Zonne-energie
Rapport over Grafeen
Titelpagina Ontwerp en Indeling
Het hoofdstuk over technische documentatie ontwerp presenteert een vrij spartaanse idee van de titelpagina, hier links weergegeven. Veel techdocs bevatten echter prachtige afbeeldingen op de titelpagina, zoals rechts weergegeven:
 |
 |
Ik zou uw gedachten, reacties en kritiek over dit hoofdstuk op prijs stellen: jouw reactie—David McMurrey.
