Klik hier om te helpen David McMurrey betaal zijn webhostingrekening:
Doneer elk klein bedrag dat je kunt!
Online technisch schrijven blijft gratis.
Titelformulering
Titels van langere documenten zoals formele technische documenten, gebruikershandleidingen en whitepapers zijn soms te kort. Bijvoorbeeld, als de titel van een technisch document "Rapport over Plasticvervuiling" zou zijn, kan het document meer dan 300 pagina's beslaan. Als het "Evaluatie van Methoden voor het Recyclen van Plastic" zou zijn, zou het document wellicht beter beheersbaar zijn.
Natuurlijk wil je niet dat een document de titel draagt van die welke John Milton, de Engelse dichter, in 1641 heeft vervaardigd: Van de Hervorming van de Kerkdiscipline in Engeland: En de Oorzaken die tot nu toe hebben verhinderd. Twee Boeken, Geschreven aan een Vriend.
Denk gewoon aan al die dingen die je over elk van deze onderwerpen zou kunnen zeggen! Belangrijk is ook dat lezers aan de hand van zulke titels niet zullen weten wat je echt gaat behandelen.
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 hele alinea lang is:
- Onderwerp: Het onderwerp van je document kan vergelijkbaar zijn met de bovenstaande voorbeelden. Maar stop daar niet—je hebt meer werk te doen.
- Omvang: Scope verwijst naar hoe breed of hoe smal je focus op het onderwerp zal zijn. Scope en overzicht zijn niet altijd gemakkelijk te onderscheiden. Het element overzicht geeft een algemene beoordeling 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 zullen 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 toepassing van de term is dit: Ebola: Overdracht, Symptomen, Behandeling. De laatste drie woorden zijn de itemisering.
Merk op dat het proces van het creëren van een specifieke, gerichte titel vergelijkbaar is met het proces van het verduidelijken van een onderwerp, elders behandeld.
Titelformulering voorbeelden
Overweeg deze titel: Nanotechnologie: Overzicht van Medische Toepassingen. Het reusachtige onderwerp nanotechnologie is inderdaad vermeld, maar let op dat het is beperkt tot medische toepassingen en een scope-element is toegepast—overzicht.
Merk de gebruik van de dubbele punt in het voorafgaande voorbeeld op. Het stelt je in staat om minder woorden te gebruiken. Een andere mogelijkheid is Medische Toepassingen van Nanotechnologie: Overzicht.
Probleem titel formulering
Een veelvoorkomend probleem met technische documenten betreft te algemene, vage titels, bijvoorbeeld:
Rapport over Nanotechnologie
Rapport over Ebola
Rapport over Smartphones
Rapport over Zonne-energie
Rapport over Grafeen
Titelpagina Ontwerp en Indeling
Het hoofdstuk over techdoc ontwerp presenteert een vrij spartan idee van de titelpagina, hier links weergegeven. Veel techdocs hebben echter prachtige afbeeldingen opgenomen in de titelpagina, zoals rechts weergegeven:
 |
 |
Ik waardeer uw gedachten, reacties en kritiek over dit hoofdstuk: je reactie—David McMurrey.
