Hoe documentatie schrijven voor kennisoverdracht ?

Het hoeft geen betoog dat documentatie een belangrijk hulpmiddel kan zijn voor kennisoverdracht. Zeker wanneer mensen in "self service" kennis opzoeken op het Intranet, je SharePoint... dan moeten we zorgen voor teksten van hoge kwaliteit. En kwaliteit kan je expliciteren:

• hoeveel fouten staan er in de tekst?
• hoeveel leesfouten zijn er door de gebruiker?

Dit heeft fouten in de uitvoering tot gevolg, en daar zit meestal het economisch rendement van investeringen in goed schrijven. Verder kwaliteitscriteria zijn

• hoeveel tijd kost het om te lezen en een zeker percentage te onthouden ?
• hoeveel tijd kost het om te schrijven ?

Om dit te bevorderen bestaan er methodes om gestructureerd te schrijven. Wat is dat? Oordeel zelf: welke van de twee berichten hieronder, met dezelfde inhoud, zou je het liefst krijgen? En waarom?

Je merkt dat dit gestructureerd schrijven bijdraagt tot de hoger vermeldde kwaliteitscriteria. In het bijzonder zorgt de tabel er voor dat de auteur niet vergeet een vakje in te vullen. Wie actie moet ondernemen ziet precies op 1 lijn wat zij/hij moet doen, zonder mogelijke verwarring of overwoekering door andere stukken tekst.

Comments

[Geplaatst door: Bart Stevens]

Volgende stap: hoe ervoor zorgen dat documentatie ook gelezen wordt? Vooral als de auteur in dezelfde organisatie werkt vinden mensen het vaak handiger om de persoon te bevragen in plaats van de documentatie te lezen. Dat is een andere dimensie van het beruchte 'RTFM probleem'. Je steekt veel tijd in het opstellen van goede documentatie, maar vaak denken mensen er zelfs niet aan dat die bestaat en dat ze die eerst moeten consulteren.

[Geplaatst door: YvesBarbion]

Hoe kan je ervoor zorgen dat de mensen de documentatie gebruiken? Een paar tips:
• door de documentatie zelf helder, toegankelijk en gebruiksvriendelijk te maken, dus goed gestructureerd
• door de documentatie aan te bieden in een formaat dat de gebruiker handig vindt, en dit kan voor elke gebruiker verschillend zijn: de ene verkiest een PDF die hij/zij dan misschien wil afdrukken, de andere wil de documentatie op een tablet zien, en nog anderen misschien op hun smartphone
• door de documentatie ook vindbaar te maken (“searchable, findable, discoverable”), en dit kan alleen als die documentatie ergens online staat.

Je hebt gelijk als je zegt dat mensen het vaak handiger vinden om een deskundige te bevragen in plaats van de documentatie te lezen. Maar wat als die persoon dan niet meer in de organisatie is, bijvoorbeeld door vakantie, pensioen, ontlag of ziekte? Op dat moment wordt dan vaak het belang van kennisborging pijnlijk duidelijk.