Documentatie die zichzelf controleert

Over dit project

Documentatie rot in stilte. Een pagina zegt dat een dienst acht modules heeft, de code heeft er dertien, en niemand merkt het tot iemand nieuw de pagina gelooft. We waren het beu dat dat stil faalt, dus maakten we het meetbaar.

De tool leest drie dingen tegelijk: wat de code effectief bevat, de notities die we ernaast schrijven, en de documentatie zoals ze gepubliceerd is. Hij brengt in kaart hoe die samenhangen, houdt bij waarop elke bewering steunt, en meldt wat niet meer klopt. Verander een module en je kan vragen welke pagina's daardoor fout werden.

Hij schrijft nooit proza. Hij vergelijkt en telt alleen, en net dat maakt hem het vertrouwen waard, en daarom vraagt onze eigen AI-tooling het aan hem in plaats van naar de codebase te gissen. Formulering en vertaling zitten erbovenop, waar fout zitten goedkoop te herstellen is.

Hoogtepunten

• Vergelijkt de code, onze notities en de gepubliceerde docs in één beweging
• Houdt bij waarop elke bewering steunt, zodat niets op geheugen steunt
• Meldt de pagina's die niet meer met de code overeenkomen
• Verander een module, zie welke pagina's daardoor verouderd zijn
• Hij vergelijkt en telt, schrijft nooit, zodat tooling er veilig op kan bouwen