Laat ons eerlijk zijn. De meeste projectmanagers en teamleden zijn meer geïnteresseerd in het inhoudelijke projectresultaat, dan in de eindgebruiker documentatie.
Bovenstaande cartoon is natuurlijk een erg uitvergrote karikatuur, doch is voor velen herkenbaar.
Projectdocumentatie wordt teveel stiefmoederlijk behandeld, tot groot ongenoegen van de klant/eindgebruiker. Vele discussies en problemen zijn op het einde van de Project Life Cycle dan ook het gevolg van onzorgvuldige project einddocumentatie.
2 soorten documentatie
Het ontwikkelen van goede en volledige projectdocumentatie kost tijd, moeite en geld. Daar wordt nu net op gesnoeid bij de budgetbespreking of tijdens het onderweg bijsturen van een ontspoord project. Zodoende wordt alleen de noodzakelijke documentatie voor de projectrealisatie verzorgd en wordt de eindgebruiker documentatie tot het absolute minimum beperkt.
Het is nu net die eindgebruiker documentatie die bij het eindresultaat hoort en dus integraal mee deel uitmaakt van het projectsucces. De informatie/documentatie die nodig was om het project succesvol van start naar finish te brengen is nadien minder belangrijk voor de eindgebruiker.
Welke informatie verwacht de eindgebruiker ? Vraag het !
7 Tips voor betere projectdocumentatie
Tip # 1 : gebruik zoveel mogelijk beelden
Beelden zeggen meer dan 1000 woorden. Mensen zijn veelal visueel ingesteld waardoor beelden meer aanspreken dan dikke dossiers met alleen tekst.
Gebruik tekeningen, mindmaps, schetsen, diagrammen, foto’s van situaties, tabellen, enz. Dankzij de moderne digitale hulpmiddelen is het zelfs vrij eenvoudig om filmpjes te maken zodat beeld en audio samen verklaring geven, aanvullend op tekst.
Tip # 2 : Don’t presume to assume
Zelfs al ben je van mening dat je de eindgebruiker goed kent, maakt nooit de fout om te denken dat hij jouw documentatie begrijpt op de manier dat jij ze hebt opgemaakt.
Stap-per-stap beschrijvingen kunnen soms kinderlijk en evident lijken, maar sommige gebruikers slagen er dan nog steeds in om dingen verkeerd te doen.
Tip # 3 : Geef realistische voorbeelden
Heb je ooit al eens het gevoel gehad dat een handleiding precies werd geschreven door een robot ipv door een mens ? Niet erg bevorderlijk voor goede communicatie. Beschrijf dus resultaten aan de hand van bestaande of nieuwe situaties. Spreek de taal van de klant en leg in zijn eigen woorden uit hoe iets werkt of hoe iets gaat gerealiseerd worden. Toon dit aan met voorbeelden uit zijn/haar leef en werk wereld.
Tip # 4 : Test je documentatie
Plaats jezelf in de plaats van de onwetende gebruiker en volg jouw eigen instructies blindelings (of laat een collega dat doen). Het resultaat is soms wel erg grappig. Ontwikkel de documentatie samen met de eindgebruiker !
Tip # 5 : Anticipeer op problemen
Niets is perfect, dus er kan altijd wat fout gaan. Anticipeer hierop door foutieve situaties te beschrijven : oorzaak, gevolg, oplossing en hoe te vermijden.
Tip # 6 : Start zo vroeg mogelijk in het project
Wacht niet tot het project bijna volledig klaar is om te starten met de einddocumentatie. Op dat ogenblik kan reeds waardevolle informatie en kennis weg zijn. Start dus zo vroeg mogelijk en betrek zoveel mogelijk mensen om de juiste informatie te vergaren en te documentaren. Betrek de eindgebruiker in het ontwikkel en creatieproces.
Tip # 7 : Ken en respecteer de richtlijnen van de klant
Gebruikersdocumentatie dient in vele gevallen aan specifieke vereisten te voldoen (taal, vormgeving, opmaak, aflevervorm, enz. Zorg dat je deze vereisten vooraf kent en begrijpt, zodat je hiermee kan rekening houden tijdens het ontwikkel en creatieprocess. Verifieer of je klant op de hoogte is van de meest recente ontwikkelingen qua regelgeving omtrent gebruikersdocumenatie.
