AI Productdocumentatietool: maak productgidsen op basis van schermopnames

Een AI-tool voor productdocumentatie die een productfunctieregistratie omzet in documentatie die je klanten en team echt kunnen gebruiken. Trupeer legt het workflow vast, genereert de handleiding met een screenshot voor elke stap en laat deze bewerkbaar, zodat je deze kunt publiceren. Wanneer het product verandert, neem je de betreffende workflow opnieuw op en werk je de documentatie bij.

Wat is een AI-tool voor productdocumentatie?

Software die productteams helpt om documentatie te maken en te onderhouden waarin wordt uitgelegd hoe een product werkt en hoe gebruikers taken erin afronden. Functiegidsen, gebruikershandleidingen, artikelen voor het helpcentrum, interne producttraining.

Dit is geen tool voor vereisten. Productdocumentatie beschrijft een product dat al bestaat; een PRD beschrijft er één dat nog niet bestaat. Als je specificaties schrijft voordat er gebouwd wordt, is dit de verkeerde categorie.

Het AI-gedeelte is belangrijk, omdat het alternatief is om een functie na de release uit het geheugen te reconstrueren, en dat is precies wanneer de documentatie achterloopt op het product.

Wat kan een AI-tool voor productdocumentatie maken?

Hoe werkt de AI-tool voor productdocumentatie?

Stap 1: Neem een productfunctie of workflow op

Leg de functie vast in je browser terwijl je hem gebruikt, of upload een opname die je al hebt. Opnemen tijdens ontwikkeling of testen werkt goed, omdat de build vers is en de documentatie met de release kan meegaan in plaats van erna.

Stap 2: Genereer de productgids

Trupeer identificeert de stappen in de opname en maakt documentatie met een screenshot die voor elke stap is vastgelegd, samen met een videoversie van dezelfde opname.

Stap 3: Controleer, pas branding toe en publiceer

Bewerk de tekst, wijzig de opmaak, voeg afbeeldingen toe of vervang ze, pas zoeken-en-vervangen toe in het hele document en deel het vervolgens of exporteer het naar PDF of Word. Voeg de prijsregels, limieten en edge cases toe die de opname niet kon laten zien voordat het wordt gepubliceerd.

Waarom een AI-tool voor productdocumentatie gebruiken?

Omdat het productie-gedeelte het deel is dat zich herhaalt. Eén opname van het product geeft je:

• Geschreven stappen gegenereerd op basis van de acties die zijn uitgevoerd, niet achteraf uit het geheugen

• Een screenshot voor elke stap, in plaats van één voor één maken en achteraf bijsnijden

• Een videoversie van dezelfde bron, in plaats van een aparte opnamesessie

• Een bewerkbaar concept, zodat review het schrijven vervangt terwijl de menselijke taak wordt uitgevoerd

• Vertaalde versies uit één bron waar markten dat nodig hebben

• Een route om bij te werken: neem de workflow die is veranderd opnieuw op in plaats van de pagina opnieuw te schrijven

Wat je met Trupeer kunt doen

• Maak functiegidsen uit product-walkthroughs:
  neem de functie op terwijl je hem gebruikt en de walkthrough wordt een stapsgewijze handleiding.

• Genereer stapsgewijze screenshots:
  voor elke stap wordt een screenshot vastgelegd vanuit de opname, in plaats van dat je ze achteraf afzonderlijk maakt en bijsnijdt.

• Zet dezelfde opname om in een walkthrough-video:
  de video komt uit de opname die je al hebt gemaakt, dus beschrijft dezelfde workflow als de geschreven gids.

• Bewerk en personaliseer de gegenereerde documentatie:
  wijzig de tekst en opmaak, voeg afbeeldingen toe of vervang ze en gebruik zoeken-en-vervangen in het hele document voordat het wordt gepubliceerd.

• Vertaal voor verschillende markten:
  publiceer dezelfde documentatie in andere talen vanuit één bron, in plaats van per markt een document te onderhouden.

• Exporteer of deel de voltooide gids:
  deel het direct of exporteer naar PDF of Word wanneer een bestand vereist is.

Voor en na: documenteer een nieuwe functie

Voor: een productmanager neemt een zeven minuten durende walkthrough op van een nieuwe analytics-functie.

Na: een stapsgewijze geschreven handleiding, een screenshot voor elke actie, een videowalkthrough uit dezelfde opname, een bewerkbaar concept dat het team beoordeelt, vertaalde versies waar markten dat nodig hebben en output die gedeeld of geëxporteerd kan worden.

De gids wordt niet als een aparte taak geschreven en de trainingvideo wordt niet twee keer opgenomen. Wanneer het analytics-scherm verandert, neemt het team het betreffende gedeelte opnieuw op.

Wat hoort in een productgids

De opname geeft je de stappen. Dit zijn de onderdelen die het niet kan geven, en dit is wat een bruikbare productgids onderscheidt van een transcript van iemand die klikt.

• Voor wie dit is en wat het veronderstelt:
  het plan, de rol of de toestemming die nodig is vóór stap één

• Waar de functie voor is:
  de taak die het uitvoert, in de termen van de lezer in plaats van de functienaam

• De limieten:
  bestandsformaten, rij-aantallen, rate limits en beperkingen van het plan, die onzichtbaar blijven totdat iemand ze tegenkomt

• Wat er gebeurt na de actie:
  of de wijziging direct is, in een wachtrij staat of wacht op iemand anders om het goed te keuren

• De meest voorkomende fout:
  de fout die de meeste lezers zullen tegenkomen, waardoor die ontstaat en wat je eraan kunt doen

• Waar je naartoe gaat:
  de gerelateerde taak die de meeste mensen meteen daarna uitvoeren

Waar productteams dit gebruiken

• Nieuwe productfuncties documenteren: zodat de gids met de release wordt geleverd in plaats van erachteraan

• Functiegidsen voor klanten maken: dezelfde workflow, geschreven voor gebruikers in plaats van voor het team

• Product-walkthroughs omzetten in artikelen voor het helpcentrum: ondersteunende content geproduceerd vanuit de functie zelf

• Interne producttraining maken: enablement voor support en sales vóór de lancering

• Documentatie bijwerken na productwijzigingen: leg opnieuw vast wat is veranderd in plaats van de pagina opnieuw te schrijven

Waarom productdocumentatie achterblijft

Twee structurele redenen, en ze versterken elkaar.

• Het veroudert bij elke release: een redesign maakt de tekst ongeldig en elke screenshot tegelijk

• Het concurreert met het uitbrengen: definitieve productdocumentatie moet meestal wachten tot de functie werkt, en dat is dezelfde week waarin iedereen druk is met het lanceren ervan

Opnemen tijdens het testen in plaats van na de lancering verplaatst het werk naar voren, naar een moment waarop iemand al bewust door de functie klikt. De opname van een QA-ronde is vaak genoeg om het eerste concept te genereren, waardoor de documentatietaak bij de lancering neerkomt op het beoordelen van een concept in plaats van vanaf nul te schrijven.

Eén productworkflow kan ook verschillende documentatie worden voor klanten, support, sales of interne teams, waardoor de noodzaak verdwijnt om dezelfde walkthrough voor elk publiek opnieuw te maken.

Handmatige vs AI-ondersteunde productdocumentatie

Productdocumentatie vs andere documentatie

Wat dit niet doet

Het schrijft geen vereisten of specificaties, bepaalt niet wat er gedocumenteerd moet worden en levert niets aan dat niet zichtbaar was in de opname. Prijsregels, limieten van het plan, goedkeuringsvoorwaarden en de redenatie achter een ontwerpkeuze moeten allemaal worden toegevoegd door iemand die ze kent.

Voor het controleren van een gegenereerd concept voordat het wordt gepubliceerd, zie AI documentation accuracy. Als je documentatie net zo veel interne tooling en admin-schermen behandelt als functies voor klanten, de AI software documentation generator is beter passend.

Zet je volgende product-walkthrough om in documentatie

Neem één keer een functie op en maak een herbruikbare productgids met screenshots en video. Probeer Trupeer gratis.