Betrouwbare functionele documentatie

Hoe zet u productinformatie om in een bruikbare handleiding zonder AI gedrag te laten verzinnen?

1250 € per sessie, excl. btw

Samengevat

Deze halve dag van 3 uur biedt een begeleide kennismaking met generatieve AI voor het schrijven van functionele documentatie. Op basis van fictieve specificaties structureren de deelnemers een handleiding, beschrijven ze gebruikersscenario’s en controleren ze elke bewering. Ze gaan naar huis met een nagelezen document, een herbruikbare prompt en een controlelijst.

Waarom deze opleiding?

Een onvolledige handleiding laat de gebruiker raden welke rechten nodig zijn, welke stappen gevolgd moeten worden of wat de gevolgen van een actie zijn. Door het standaardscenario, de beperkingen en de foutsituaties van elkaar te onderscheiden, worden die onduidelijkheden al tijdens het schrijven verminderd. AI kan helpen om notities te ordenen en instructies te herformuleren, maar kan ook een niet-bestaande knop of regel toevoegen. Het werk draait daarom evenzeer om de traceerbaarheid van beweringen als om de leesbaarheid van de tekst. Doorlopende casus: De fictieve organisatie Brumelis Archives voegt aan haar portaal een functie toe om dossiers tijdelijk te delen. Alleen de eigenaar kan een link aanmaken, die zeven dagen geldig is en ingetrokken kan worden. De ontvanger kan de dossiers bekijken, maar niet wijzigen. De deelnemers schrijven de handleiding op basis van aangeleverde schermontwerpen en regels, waarbij bepaalde informatie bewust ontbreekt. Toepassing op het werk: Voor een eenvoudige functionaliteit van hun organisatie kunnen de deelnemers het sjabloon hergebruiken, de toegestane bronnen verzamelen en de handleiding vóór publicatie laten nalezen door een productverantwoordelijke. Met de controlelijst kunnen ze het concept en de gecorrigeerde versie vergelijken.

De doelstellingen van deze opleiding

  • De lezer, diens behoefte en de grenzen van de functionaliteit bepalen.
  • De informatie indelen in bevestigde feiten, aannames en open vragen.
  • Een AI-prompt schrijven op basis van afgebakende bronnen.
  • Een standaardscenario en twee bijzondere situaties beschrijven.
  • Met een controlelijst nagaan of een handleiding brongetrouw en leesbaar is.

Voor wie en met welke voorkennis?

Betrokken rollen en taken

  • Product- en supportmedewerkers die een functionaliteit aan gebruikers moeten uitleggen.
  • Ontwikkelaars en testers die willen bijdragen aan een toegankelijke functionele handleiding.

Vereiste voorkennis

  • Geen voorkennis van AI vereist; de eerste prompts worden stap voor stap opgesteld.
  • De stappen van een actie in een toepassing kunnen beschrijven, zonder programmeerkennis.

Waaraan u werkt

  1. Afbakenen wat de handleiding moet uitleggen

    Doel: Beschikbare feiten scheiden van ontbrekende informatie. Beoogde lezer, gebruiksdoel, referentiebronnen; kennismaking met plausibele maar niet-geverifieerde AI-antwoorden.

  2. Een structuur opbouwen en de assistent aansturen

    Doel: Een structuur verkrijgen die geschikt is voor tijdelijk delen. Rubrieken: nut, toegangsvoorwaarden, stappen, resultaat, beperkingen; expliciete instructie om ontbrekende informatie niet aan te vullen.

  3. Gebruikersscenario’s uitschrijven zonder te extrapoleren

    Doel: Controleerbare en begrijpelijke instructies opstellen. Genummerde stappen, interfaceterminologie, verwacht resultaat; beschrijving van het verlopen en intrekken van links zonder systeemberichten te verzinnen.

  4. Nalezen vanuit het perspectief van de gebruiker

    Doel: De tekortkomingen van het concept meten en corrigeren. Controle op brongetrouwheid, volledigheid en leesbaarheid; onderscheid tussen het nalezen van documentatie en het valideren van de werkelijke werking.

Wat u meeneemt

  • Fiche met het lezersprofiel en bronnenoverzicht.
  • Sjabloon voor de handleiding en schrijfopdracht met toelichting.
  • Gecorrigeerde handleiding voor tijdelijk delen, met onbeantwoorde vragen.
  • Controlelijst ingevuld vóór en na de correctie.

Methode en evaluatie

  • Korte toelichtingen, onmiddellijk gevolgd door praktijkoefeningen rond de doorlopende casus.
  • Individueel werk, gevolgd door werk per twee, waarbij deelnemers elkaars resultaten nalezen.
  • Begeleide groepsbespreking: wat werkt, wat gecorrigeerd moet worden en wat een menselijke beslissing blijft.
  • Voorbereiding: Zorg voor toegang tot een door de organisatie toegestane generatieve AI-assistent en een teksteditor. Lees het aangeleverde fictieve dossier; elk aanvullend voorbeeld moet vóór gebruik geanonimiseerd zijn en goedgekeurd zijn voor gebruik.

Observeerbare criteria: Elke beschreven regel verwijst naar een aangeleverde bron; onbekende gegevens worden aangegeven. ; Het gebruikersscenario vermeldt de vereiste rechten, de acties en het verwachte resultaat. ; De gevallen van een verlopen link en een ingetrokken link worden onderscheiden zonder gedrag te verzinnen. ; De benamingen komen overeen met de schermontwerpen en de instructies gebruiken actiewerkwoorden. ; Het aantal behaalde criteria wordt vóór en na de correctie genoteerd, met verantwoording..

Veelgestelde vragen

Moet u kunnen programmeren?

Nee. De oefening beschrijft het gebruik en de zichtbare regels, niet de technische implementatie.

Kunt u interne specificaties gebruiken?

Alleen als het gebruik ervan is toegestaan en de inhoud geanonimiseerd is; het fictieve dossier volstaat.

Valideert AI de functionaliteit?

Nee. AI helpt bij het schrijven; de bronnen en de menselijke controle blijven doorslaggevend.

Kan de handleiding meteen gepubliceerd worden?

De handleiding is een resultaat van de oefening. Voor toepassing in een echte situatie moeten de onbekende gegevens bevestigd worden en is validatie door het productteam vereist.

Laatst bijgewerkt: