Een stapsgewijze handleiding voor het maken en beheren van productdocumentatie | Productbeheer #31

Wat is productdocumentatie?

Productdocumentatie is een verzameling van tekst, visuals en video’s die het product, de functies, de manier waarop het gebruikt moet worden en andere relevante details beschrijft. Het primaire doel van het maken van documentatie is om gebruikers te helpen begrijpen hoe ze het product moeten gebruiken, en vooral de geavanceerde functies.

Documentatie is belangrijk, vooral als je een digitaal product maakt dat niet alleen eindgebruikers bedient, maar ook integreert met andere producten – bijvoorbeeld, zodat je gegevens naar een andere applicatie kunt exporteren, of een lokalisatie- of contactdatabase kunt gebruiken.

Documentatie voor een projectmanagementtool kan bijvoorbeeld informatie bevatten over hoe je een nieuw project aanmaakt, hoe je teamleden aan een project toevoegt en hen toestemming geeft om alleen bepaalde taken te wijzigen, hoe je taken gelijktijdig aan meerdere mensen toewijst, en hoe je hun voortgang bijhoudt.

Elementen van productdocumentatie

Productdocumentatie kan bevatten:

• Gebruikershandleiding – een document dat informatie biedt over productkenmerken, installatie, instellingen en probleemoplossing.
• Gebruikersgids – een document dat uitlegt hoe je verschillende taken met het product uitvoert, zoals hoe je een fotobewerkingsprogramma gebruikt of hoe je een computerspel speelt.
• Kennisbank – een verzameling artikelen of webpagina’s die veelgestelde vragen beantwoorden of aanvullende informatie over een product bieden. Een voorbeeld zou de “Helpcentrum” of “Ondersteuning” sectie op de website zijn. Het wordt ook vaak gebruikt als informatiebron voor een chatbot die klanten helpt.
• FAQ – een lijst van veelgestelde vragen en antwoorden over het product. Bijvoorbeeld, een website of PDF-bestand dat antwoorden bevat op vragen zoals: “Hoe reset ik mijn wachtwoord?”, “Hoe neem ik contact op met de klantenservice?” of “Wat zijn de systeemeisen voor het product?”.
• Handleidingen – video’s, meestal geplaatst op de website van het bedrijf of YouTube, die demonstreren hoe je het product gebruikt of bepaalde taken uitvoert.
• Diagrammen en infographics – grafische weergaven van de structuur, functie of het proces van een product. Bijvoorbeeld, een diagram dat laat zien welke opties je moet selecteren bij het configureren van een API.

Hoe maak je productdocumentatie?

Begrijpen van de doelgroep

De eerste stap in het maken van productdocumentatie is het begrijpen van het publiek waarvoor dit specifieke document bedoeld is. Beantwoord de volgende vragen:

• Wie zal dit document gebruiken? – Is het een eerste gebruiker of een meer gevorderde gebruiker?
• Op welk moment zal de gebruiker dit document raadplegen? Zoeken ze naar algemene of extra informatie over de mogelijkheden van de tool, of naar een oplossing voor een specifiek probleem?
• Op welk apparaat zullen ze het gebruiken? Als het een mobiel apparaat is, zijn de video’s dan duidelijk genoeg?
• Wat zijn hun behoeften en verwachtingen? Heeft de gebruiker de voorkeur om een dynamische video te bekijken of naar een diagram te kijken?

Als je eenmaal je publiek en hun behoeften begrijpt, kun je beginnen met het maken van je documentatie. Als je doelgroep bijvoorbeeld beginnende gebruikers zijn, moet de documentatie toegankelijk zijn op elke stap van de weg, geschreven in eenvoudige, gemakkelijk te begrijpen taal, en gedetailleerde instructies bevatten.

Vergeet niet dat goed georganiseerde documentatie niet alleen helpt gebruikers het product te begrijpen, maar ook tijd bespaart die ze anders misschien aan het zoeken naar antwoorden op hun vragen zouden besteden. Dit vermindert het verloop, dat wil zeggen, het percentage klanten dat stopt met het abonneren op een dienst.

Duidelijke communicatie

Effectieve productdocumentatie maken gaat niet alleen om het kiezen van de juiste communicatiemiddelen (bijv. video’s, visuals, kennisbank), maar ook om duidelijk en beknopt te schrijven en te communiceren. De basisprincipes van effectieve communicatie in productdocumentatie zijn als volgt:

• Gebruik eenvoudige taal – vermijd technische taal en ingewikkelde termen. In plaats van te zeggen “initieer een project,” kun je zeggen “start een project.”
• Wees specifiek – geef voorbeelden om gebruikers te helpen begrijpen hoe ze het product moeten gebruiken. In plaats van te zeggen “maakt het mogelijk om teamleden aan een project toe te voegen,” zeg “voeg een teamlid aan een project toe door op de groene knop onderaan de projectmanagementpagina te klikken” en voeg een screenshot met een visuele aanwijzing toe.
• Vermijd de lijdende vorm – de actieve vorm is gemakkelijker te begrijpen en te lezen. In plaats van te zeggen “het project kan door de manager worden gestart,” zeg “de manager kan het project starten.”

Er zijn veel andere principes om te volgen, maar het belangrijkste is om te onthouden dat effectieve productdocumentatie begrijpelijk moet zijn voor gebruikers en hen moet helpen het product effectief te gebruiken.

Visuele elementen in productdocumentatie gebruiken

Visuele elementen, zoals afbeeldingen, gifs, korte video’s, diagrammen en infographics, kunnen het begrip van productdocumentatie aanzienlijk verbeteren. Een screenshot dat laat zien waar de knop “Teamlid toevoegen” zich op de pagina bevindt, kan bijvoorbeeld zeer nuttig zijn voor eerste gebruikers. Bij het maken van documentatie, gebruik ook duidelijke koppen en een eenvoudig lettertype om de tekst te organiseren.

Bijwerken en onderhouden van productdocumentatie

Productdocumentatie is geen statisch document. Het moet regelmatig worden bijgewerkt om veranderingen in het product weer te geven. Regelmatige updates zijn cruciaal voor de documentatie om zijn doel te dienen. Als je bijvoorbeeld een nieuwe functie aan je projectmanagementsoftware introduceert, moet je de productdocumentatie bijwerken om dit aan te pakken.

Publiceren en verspreiden van productdocumentatie

Het publiceren en verspreiden van productdocumentatie is net zo belangrijk als het maken ervan. Je moet ervoor zorgen dat je documentatie gemakkelijk toegankelijk is voor gebruikers, ongeacht waar ze zijn of welk apparaat ze gebruiken. Je kunt je productdocumentatie bijvoorbeeld op je website uploaden, of het rechtstreeks naar gebruikers via e-mail sturen.

Top documentbeheersystemen voor productmanagers

Productmanagers hebben veel tools tot hun beschikking die hen kunnen helpen bij het maken en beheren van productdocumentatie. Populaire oplossingen zijn:

• Google Docs is een cloudgebaseerde service voor het maken en bewerken van documenten. Het is een populaire tool voor productmanagers omdat je het op elk apparaat kunt openen en het door meerdere teamleden kan worden gebruikt.

• Firmbee is een uitgebreide project- en teammanagementtool die gebruikers in staat stelt om taken vanuit de hele wereld in realtime te voltooien. Productmanagers kunnen hun werk en dat van hun collega’s gemakkelijk organiseren, voortgang bijhouden, budgetten controleren en wervingsprocessen uitvoeren.

• Notion is een taak- en projectmanagementapplicatie die kan worden gebruikt om taken, notities en bestanden bij te houden. Notion is een populaire optie voor productmanagers omdat het flexibel is en kan worden aangepast.

• Zendesk Guide is een klantenservicetool die kan worden gebruikt om kennisbankartikelen te maken en te delen. Zendesk Guide is een populaire keuze voor productmanagers omdat het hen in staat stelt om ondersteuning te bieden en klanten te helpen hun problemen op te lossen.

Samenvatting

Het creëren en beheren van productdocumentatie is een vaak onderschatte taak. Veel ontwikkelaars van digitale producten geloven dat een goed ontworpen product vanzelfsprekend is. Productdocumentatie moet echter meer zijn dan alleen een gebruikersgids.

Het moet ook een hulpmiddel zijn dat kan helpen de bewustwording van klanten over het product te vergroten en hun interesse in nieuwe functies te analyseren, evenals het aantal weergaven van specifieke artikelen of uitleg. Dergelijke analyses helpen bedrijven hun producten beter te beheren en de gebruikerservaring te verbeteren. Het is dus de moeite waard om tijd en moeite te investeren in het creëren van effectieve productdocumentatie die zowel jou als je gebruikers kan dienen.

Als je onze inhoud leuk vindt, sluit je dan aan bij onze drukke bijengemeenschap op Facebook, Twitter, LinkedIn, Instagram, YouTube, Pinterest, TikTok.