QAIYU Docs

Documentatie faalt op een van twee manieren. Of niemand kan het antwoord vinden, of het antwoord is drie versies oud. Allebei zien er voor de lezer precies hetzelfde uit.

Structuur lost het eerste op: pagina’s genoemd naar de vraag die iemand heeft, in plaats van naar de functie die hij gebruikt. Een vast moment om alles na te lopen lost het tweede op, en zonder zo’n moment zakt elk documentatieproject binnen een jaar weer in.

Je documentatie is ook je chatbot

Alles wat je opschrijft, is waar een supportbot uit antwoordt. Vage documentatie levert een vage bot op, en de snelste manier om geautomatiseerde support te verbeteren is meestal de bron repareren en niet het model.

Wat we van jou nodig hebben

Wat er nu ligt, hoe rommelig ook. Een rommelig beginpunt is meer waard dan een leeg blad.

Geordend op vraag, niet op functie

Documentatie die de opbouw van het product volgt, weerspiegelt hoe de bouwers denken. Documentatie die de vragen volgt, weerspiegelt hoe de gebruikers denken, en die twee hebben zelden dezelfde vorm.

Een pagina met de titel “Rechten” is een functie. Een pagina met de titel “Waarom kan een collega mijn project niet zien” is een vraag, en dat is wat er in het zoekvak getypt werd. Hernoemen is de goedkoopste verbetering die de meeste documentatie kan krijgen.

Een vast moment om na te lopen, of het zakt in

Elk documentatieproject klopt op de dag van oplevering en drijft af tegen het einde van het kwartaal. Zonder een vast moment om te controleren blijft die afdrijving onzichtbaar, tot iemand een instructie volgt die niet meer werkt.

Daarom krijgt elk onderdeel een eigen controle-interval, gebaseerd op hoe snel dat deel verandert. Onderdelen die niemand nakijkt worden gemarkeerd in plaats van stilletjes te verouderen.

Hier antwoordt je chatbot uit

Alles wat je opschrijft is de bron waar een supportagent uit put. Daarmee zijn de kwaliteit van je documentatie en de kwaliteit van je geautomatiseerde support hetzelfde probleem, en dat is niet vanzelfsprekend tot je een bot een vaag antwoord hebt zien geven en het hebt teruggevonden op een vage pagina.

De snelste route naar betere geautomatiseerde support is meestal de bron repareren en niet het model wisselen. Dat is onwelkom advies, want het betekent schrijven voordat je koopt. Het blijft de goede volgorde.

Wat je als eerste terugkrijgt

Voordat er iets herschreven wordt, krijg je de lijst met gaten: vragen die je gebruikers stellen en die nergens beantwoord worden, pagina’s die elkaar tegenspreken, en instructies die niet meer bij het product passen. Die lijst is vaak het nuttigste deel van de opdracht, en hij bestaat of het schrijfwerk nu doorgaat of niet. Dat patroon, een document dat je houdt ook als je stopt, geldt voor elke fase bij hoe een project loopt.

Documentatie wordt zelden op zichzelf besteld, want de waarde ervan wordt zichtbaar in wat eruit antwoordt. Vraag een demo aan, dan komt de lijst met gaten uit dat eerste gesprek.