Zo maak je documentatie die gelezen wordt

© CIDimport

Zo maak je documentatie die gelezen wordt

Geplaatst: 30 mei 2012 - 04:59

Aangepast: 13 december 2022 - 18:59

Redactie ID.nl

Een belangrijk onderdeel van het draaiende houden van een bedrijf is simpele processen te hebben die gebruikers gemakkelijk kunnen leren en herhalen. Of het proces nu het invullen van een uitgavenformulier, het verwerken van een klacht of het schrijven van een blog betreft; in ieder bedrijf zijn processen aanwezig die door meerdere mensen worden uitgevoerd.

Het probleem is in veel gevallen het effectief overdragen van informatie en gebruikers daadwerkelijk iets leren over de te volgen handelingen bij processen. De Amerikaanse luchtmacht heeft gedocumenteerde procedures (Technical Orders) voor bijna alles voor wat je zou kunnen bedenken, van het strikken van je veters tot het lanceren van een lange afstandsraket. Ik was zelf een tijdje verantwoordelijk voor deze TO's toen ik diende in New Mexico. Het probleem van deze documentatie is niet dat het te weinig informatie biedt, integendeel. Het probleem van deze TO's is dat ze vaak enorm saai zijn.

Zo maak je documentatie die gelezen wordt-15082296

© CIDimport

Kies waar mogelijk voor beeld in plaats van tekst

Veel mensen leren beter van afbeeldingen en te zien hoe iets gedaan moet worden dan erover te lezen. Wat je daarom zou willen is iets te creëren dat meer voorstelt dan zwarte tekst op een witte achtergrond. Een handleiding met afbeeldingen van de te nemen stappen waarmee gebruikers hun eigen handelingen kunnen controleren is daarvoor het ideale middel.

Wanneer je interessantere handleidingen wilt maken om gebruikers te leren bepaalde taken te voltooien of functies uit te oefenen, is Snapguide een prima keuze. Deze gratis iPhone-applicatie maakt het maken van visuele stappenplannen door middel van afbeeldingen, tekst en zelfs video een fluitje van een cent.

Na het inloggen via Facebook, Twitter of een Snapguide-account, begin je met het aantikken van het 'Create'-icoontje aan de onderkant van de app. Vervolgens voer je een titel voor je 'tutorial' in. Snapguide begint met een 'How to'-sjabloon. Hier kun je vervolgens iedere denkbare handleiding mee opzetten.

Op de pagina Editor binnen de app, kun je een lijst met benodigdheden opstellen die vereist zijn om het stappenplan uit te voeren. Daarna kun je met 'Add + Step' stappen toevoegen, in de vorm van tekst, afbeeldingen of video.

Je kunt een onbeperkt aantal foto's en video's toevoegen. Nadat je alle stappen hebt toegevoegd, kun je ze eenvoudig herschikken via een 'drag & drop'-mechanisme. Je kunt aan foto's en video's begeleidende teksten toevoegen en achteraf foto's en video's verwijderen die bij nader inzien minder geschikt blijken.

Zodra je het stappenplan voltooid hebt, kun je een omslagfoto toevoegen die gebruikers zullen zien wanneer ze jouw tutorial opvragen. Tik daarna op de knop 'Publish' om je eigen handleiding live te zetten.

Werk aan de winkel

Hoewel Snapguide een geweldige tool is om aansprekende stap-voor-stap handleidingen voor collega’s te maken, zit er een addertje onder het gras. De documentatie die Snapguide aflevert is namelijk publiek beschikbaar – het kan benaderd worden door iedereen vanaf de site van Snapguide of met de app in het bezit. Wees dus voorzichtig met het gebruik van deze app.

Het zou wenselijk zijn wanneer Snapguide een aantal controlemechanismen toevoegt zodat je kan kiezen wie toegang tot je handleidingen heeft. Snapguide zou ook een betere zoekfunctie kunnen gebruiken – überhaupt zou kunnen zoeken prettig zijn. Je kunt anderen gebruikers volgen net als bij Pinterest en je kunt door de beschikbare documentatie zoeken, maar er is (nog) geen functie op de site of binnen de app die je laat zoeken naar relevant materiaal.

Deel dit artikel
Voeg toe aan favorieten