Een website is pas echt van jou als je er ook zonder de bouwer mee verder kunt. Dat klinkt vanzelfsprekend, maar in de praktijk zit de kennis over hoe een site werkt vaak alleen in het hoofd van de ontwikkelaar. Goede technische documentatie en een nette overdracht maken je onafhankelijk. Deze gids legt uit waarom dat ertoe doet, wat erin hoort en hoe je borgt dat een volgende partij verder kan zonder gokwerk.

Waarom documentatie je onafhankelijk maakt

Stel: je ontwikkelaar stopt, wordt onbereikbaar of je wilt gewoon verder met iemand anders. Zonder documentatie staat de nieuwe partij voor een dichte deur. Die moet dan tijd, en dus geld, steken in het uitzoeken van hoe alles in elkaar zit, met het risico dat er iets breekt.

Met goede documentatie ligt die kennis vast, los van wie hem heeft gebouwd. Dat verkleint je afhankelijkheid en versterkt je positie. Het hangt nauw samen met eigendom van je code en licenties: eigendom zonder documentatie is een auto zonder sleutels.

Wat er in goede documentatie hoort

Documentatie hoeft geen lijvig boekwerk te zijn. Voor een MKB-site gaat het om de essentie, helder en vindbaar vastgelegd.

// documentatie is een brief aan de toekomst: aan jezelf over een jaar, of aan de volgende ontwikkelaar.

Documentatie in de code zelf

Naast een document voor jou hoort ook de code zelf leesbaar en uitlegbaar te zijn. Schone code met heldere namen en korte toelichtingen waar het ingewikkeld wordt, is een vorm van documentatie. Het verschil tussen code die zichzelf uitlegt en een wirwar die niemand durft aan te raken, is enorm.

Hoe dat werkt, lees je in documentatie van code en onderhoudbare code. Dit is precies het deel dat een goedkope, gehaaste oplossing overslaat, en waar een volgende partij later op vastloopt.

Een nette overdracht: de checklist

Bij oplevering of bij het wisselen van partij hoort een complete overdracht. Loop deze punten langs:

  1. Toegang tot domein, hosting en het beheerscherm staat op jouw naam.
  2. De volledige broncode is in jouw bezit of toegankelijk via een door jou beheerde plek.
  3. Er is een document dat de opbouw, koppelingen en beheerinstructies beschrijft.
  4. De afspraken over onderhoud en wie wat doet zijn vastgelegd.

Hoe je dit veilig overdraagt zonder downtime of dataverlies, staat in de gids over je website verhuizen naar een nieuwe partij.

Documentatie actueel houden

Documentatie die niet wordt bijgehouden, raakt snel achterhaald en dan vertrouwt niemand het nog. Spreek af dat bij grotere wijzigingen ook het document wordt aangepast. Dat hoort bij regulier onderhoud: het kost weinig moeite zolang je het meteen doet, en veel als je het laat oplopen.

Soepel wisselen van partij

De ultieme test van goede documentatie is het moment dat je wisselt van ontwikkelaar. Lukt dat zonder dat de nieuwe partij maandenlang moet zoeken, dan is de documentatie haar geld waard geweest. Een ontwikkelaar die eerlijk werkt, heeft er geen belang bij je vast te houden via onbegrijpelijke code; integendeel, die zorgt dat je altijd weg kunt.

Dat principe, geen lock-in, is een keuze die je vooraf bespreekt en vastlegt, zoals beschreven in de gids over eigendom van je code.

Zelf doen of uitbesteden?

Documentatie schrijven over techniek die je zelf niet hebt gebouwd, lukt niet goed; het hoort gemaakt te worden door wie de site bouwt. Wat jij wel zelf doet, is erom vragen en het bewaren. Maak documentatie en overdracht onderdeel van de afspraken, dan hoef je er later niet om te bedelen.

Bij elke maatwerk-website lever ik schone code, een beknopte documentatie en een nette overdracht, zodat je nergens aan vastzit. Wil je weten of jouw huidige site goed is gedocumenteerd? Leg het kort voor en je krijgt eerlijk antwoord, zonder verplichting.

Veelgestelde vragen

Zelfs een kleine site verdient een beknopt overzicht: waar staat hij gehost, hoe log je in, wat is er gebouwd en waar staan de toegangsgegevens. Dat hoeft geen lijvig document te zijn. Een halve pagina die het essentiele vastlegt, maakt je al een stuk minder afhankelijk.

De toegang tot domein, hosting en het beheerscherm, de broncode, een uitleg van hoe de site is opgebouwd en welke koppelingen er zijn, plus de afspraken over onderhoud. Daarmee kan een nieuwe partij verder zonder eerst alles opnieuw te moeten uitzoeken.

Het verkleint de afhankelijkheid sterk. Zonder documentatie zit de kennis alleen in het hoofd van de bouwer, en dan zit je vast. Met goede documentatie kan een andere ontwikkelaar zich inlezen en verder bouwen, wat je onderhandelingspositie en gemoedsrust ten goede komt.

Documentatie is meestal onderdeel van een nette oplevering en zit verwerkt in het project. De kosten zijn klein vergeleken met wat het bespaart als je ooit moet wisselen van partij of een storing moet oplossen. Het is een investering in onafhankelijkheid, niet een luxe.

Verder in de kennisbank: Eigendom van je code en licenties · Je website verhuizen naar een nieuwe partij · Je huisstijl in techniek vastleggen

Direct relevant: dienst maatwerk-website · artikel documentatie van code