Niet alle documentatie dient hetzelfde doel. Een stapsgewijze gids die iemand door een proces leidt, doet een totaal andere taak dan een naslagwerk dat een lijst met parameters definieert. Het verkeerd type inhoud gebruiken voor een taak is een van de meest voorkomende redenen waarom documentatie lezers in de steek laat — zelfs als de informatie zelf accuraat is.
Dit artikel beschrijft vijf kerninhoudstypen die worden gebruikt in een goed gestructureerde kennisbank, legt uit welke functie elk van hen uitvoert en helpt je te herkennen welk type geschikt is voor een bepaalde behoefte. De eerste vier zijn gebaseerd op het veelgebruikte Diátaxis-kader (tutorials, handleidingen, referenties en uitleg); Troubleshooting is hier als vijfde toegevoegd, aangezien diagnostische inhoud zich zo anders gedraagt dan beide om een eigen definitie te verdienen.
De Vijf Kerninhoudstypen
Instructiegidsen
Een handleiding leidt een lezer van begin tot eind door een specifieke taak. Het gaat ervan uit dat de lezer een doel heeft en weet waarom hij dat wil bereiken — ze hoeven alleen maar te weten hoe. Het hele artikel is opgebouwd rond actiestappen die tot een concreet resultaat leiden.
| Het werk dat het doet | Stelt een lezer in staat een taak uit de praktijk te voltooien. |
| Wanneer te gebruiken | Elke keer dat een lezer iets specifieks moet doen — een functie opzetten, een instelling configureren, een workflow voltooien. |
| Wat het niet is | Een tutorial (die lesgeeft), een referentie (die informeert), of een conceptueel artikel (dat het uitlegt). Een handleiding leert geen concepten; Het leidt de lezer door stappen. |
| Herkenbaar door | Een taakgerichte titel ("Hoe zet je tweefactorauthenticatie op"), genummerde stappen, een gedefinieerd startpunt en een duidelijk resultaat. |
Tutorials
Een tutorial leert een lezer hoe hij iets moet doen door hem het te laten doen. Het doel is leren, niet het voltooien van taken. Een lezer volgt een tutorial om begrip en vaardigheid op te bouwen, niet omdat hij een directe behoefte in de praktijk heeft. De tutorial bestuurt de omgeving — het kan voorbeeldgegevens, een sandbox of een vereenvoudigd scenario gebruiken dat speciaal voor leren is ontworpen.
Scoping-opmerking: In de praktijk is deze categorie gemakkelijk te overbelast. Als je kennisbank geen sandbox, voorbeelddataset of speciaal onboardingpad biedt, is de meeste content die als "tutorial" wordt aangeduid eigenlijk een vermommde handleiding — de lezer heeft een echte taak voor ogen, geen abstract leerdoel. Reserveer "tutorial" voor inhoud die echt onderwijst in een gecontroleerde omgeving; Anders kun je in plaats daarvan een handleiding schrijven.
| Het werk dat het doet | Bouwt competentie en vertrouwen op bij een nieuwe gebruiker. |
| Wanneer te gebruiken | Bij het inwerken van nieuwe gebruikers, het introduceren van een complexe functie, of het helpen van lezers om vaardigheden te ontwikkelen die ze nog niet hebben — echt via een gecontroleerde, leergerichte omgeving. |
| Wat het niet is | Een handleiding (die een echte taak oplost), of een conceptueel artikel (dat het uitlegt zonder te doen). Een tutorial vereist altijd actie — de lezer moet iets doen. |
| Herkenbaar door | Een leergerichte framing ("In deze tutorial leer je hoe..."), een gecontroleerde of voorbeeldomgeving, en een expliciete verklaring van wat de lezer aan het einde zal kunnen doen. |
Conceptuele artikelen
Een conceptueel artikel legt uit hoe iets werkt, wat iets is, of waarom iets zo ontworpen is. Het geeft geen instructies — het informeert. De lezer gaat weg met begrip, niet met een voltooide taak.
| Het werk dat het doet | Bouwt het mentale model dat een lezer nodig heeft om een product effectief te gebruiken. |
| Wanneer te gebruiken | Bij het introduceren van een nieuw concept, het uitleggen van de architectuur van een systeem, of het helpen van een lezer om de reden achter een ontwerpbeslissing te begrijpen voordat hij ermee in aanraking komt. |
| Wat het niet is | Een handleiding of tutorial voor het doen. Een conceptueel artikel heeft nooit genummerde stappen. Het legt uit; het geeft geen instructie. |
| Herkenbaar door | Een conceptgerichte titel ("Begrip van rolgebaseerde toegangscontrole"), proza-rijke inhoud, diagrammen en voorbeelden, en het ontbreken van procedurele stappen. |
Referentieartikelen
Een naslagwerk biedt precieze, gestructureerde informatie die lezers opzoeken, niet in volgorde lezen. Het is een bron die wordt geraadpleegd midden in een taak, niet van begin tot eind gelezen. Referentieartikelen geven de voorkeur aan volledigheid en precisie boven narratieve flow.
| Het werk dat het doet | Geeft lezers snelle toegang tot nauwkeurige, volledige technische informatie. |
| Wanneer te gebruiken | API-documentatie, parameterlijsten, sneltoetsen, foutcode-definities, glossaria's, configuratieopties — overal waar een lezer iets moet opzoeken. |
| Wat het niet is | Een tutorial of handleiding voor het volgen van de hand. Referentieartikelen leiden lezers niet door een proces. Ze verschaffen informatie; De lezer beslist wat hij ermee doet. |
| Herkenbaar door | Een gestructureerd, voorspelbaar formaat (tabellen, definitielijsten, codeblokken), een consistent patroon over de invoeren en een titel die het opzoekgedrag aangeeft ("API-referentie," "Sneltoetsen"). |
Artikelen over probleemoplossing
Een artikel over probleemoplossing helpt een lezer een probleem te diagnosticeren en op te lossen. Het is georganiseerd rond symptomen en hun oplossingen, niet rond productkenmerken. Een lezer komt omdat er iets mis is — de taak van het artikel is om hen te helpen het te identificeren en het op te lossen.
In tegenstelling tot een handleiding die begint met een doel ("Ik wil X bereiken"), begint een probleemoplossingsartikel met een symptoom ("X werkt niet"). Dat onderscheid — doel-eerst versus symptoom-eerst — is waarom probleemoplossing hier een eigen categorie krijgt in plaats van in handleidingen te vallen.
| Het werk dat het doet | Los een probleem op dat de lezer actief ervaart. |
| Wanneer te gebruiken | Foutmeldingen, onverwacht gedrag, mislukte processen, veelvoorkomende supportproblemen. |
| Wat het niet is | Een handleiding (die ervan uitgaat dat alles werkt) of een naslagwerk (dat informatie geeft zonder een specifiek probleem op te lossen). Een probleemoplossingsartikel is diagnostisch — het begint bij een symptoom, niet bij een doel. |
| Herkenbaar door | Symptoom-eerst organisatie ("Als je ziet... / Als je het niet kan..."), conditionele logica, meerdere mogelijke oorzaken van één symptoom en escalatiepaden wanneer de oplossingen in het artikel het probleem niet oplossen. |
Inhoud die niet netjes past
Deze vijf typen beslaan het grootste deel van een kennisbasis, maar niet alles. Inhoud zoals FAQ's, glossaria, release notes en productoverzicht of landingspagina's leent vaak van meer dan één type zonder volledig overeen te komen — een FAQ bijvoorbeeld gedraagt zich als een referentieartikel (opgezocht, niet van begin tot eind gelezen) maar is georganiseerd rond vragen in plaats van een gestructureerd schema. Behandel deze als hun eigen erkende uitzonderingen in plaats van ze in een van de vijf categorieën te dwingen; Wat telt is dat elk stuk content een duidelijke, eenduidige taak heeft, hoe je het ook noemt.
Contenttypes mixen
In de praktijk kan één artikel uit meer dan één inhoudstype putten. Een handleiding kan een korte conceptuele alinea bevatten om uit te leggen waarom een stap belangrijk is. Een probleemoplossingsartikel kan een referentietabel met foutcodes bevatten.
Dat is prima, zolang het primaire doel van het artikel duidelijk blijft. Lezers moeten direct kunnen herkennen wat voor soort artikel ze lezen en wat ze eruit zullen halen. Een artikel dat tegelijkertijd probeert te onderwijzen, instructeren, uitleggen en problemen oplossen, zal geen van deze dingen goed doen.
Als een artikel te veel doelen begint te dienen, splits het dan.
Het juiste contenttype kiezen
Wanneer je gaat zitten om een nieuw artikel te schrijven, stel dan eerst één vraag: wat moet mijn lezer meenemen?
| Lezer moet weglopen met... | Schrijf een... |
|---|---|
| Een voltooide taak | Handleiding |
| Een nieuwe vaardigheid of begrip, verworven door te doen | Tutorial |
| Een mentaal model of uitleg | Conceptueel artikel |
| Een specifiek stukje informatie | Referentieartikel |
| Een opgelost probleem | Probleemoplossing artikel |
Dit goed doen voordat je begint met schrijven bespaart later veel revisietijd. Een goed gekozen inhoudstype geeft het artikel zijn vorm; Een slecht gekozen speler betekent opnieuw schrijven vanaf nul.