Waarom moet je documentatie bijhouden?

Documentatie: ik moet eerlijk bekennen dat ik nog nooit een developer heb ontmoet die er om staat te springen. Gezucht, gesteun, gekreun, “Ik moet nog documentatie schrijven”, is eerder de norm. En hoewel het niet het meest spannende, interessante en inspirerende onderdeel is van programmeren of een project, is het toch onmisbaar. Als het zoveel werk is en er argumenten tegen zijn, waarom moet je dan documentatie bijhouden? In dit blog geef ik 7 goede redenen waarom Before Sales documentatie bijhoudt en elk bedrijf dat eigenlijk zou moeten doen. Ook zal ik een paar een paar kleine redenen vermelden waarom je het niet zou moeten doen. En wat is nou eigenlijkde toegevoegde waarde van deze documentatie voor onze klanten?

Wat is documentatie bijhouden?

Documentatie, bestaat uit alle digitale documenten die zijn gecreëerd door en voor de mensen die binnen een bedrijf, team of project werken. In deze documentatie kan van alles zitten zoals: projectomschrijvingen, procesdocumentatie, technische specificaties, handleidingen en educatief materiaal.

Documentatie hou je bij om de collega’s binnen een organisatie te helpen bij hoe ze hun werk moeten uitvoeren, hoe ze verschillende tools en software moeten gebruiken, of hoe ze een project succesvol moeten afronden. Je kan het ook gebruiken om nauwkeurig en regelmatig onderhoud te plegen, en om te zorgen dat iedereen toegang heeft tot dezelfde informatie. Alles bij elkaar kan een gigantisch digitaal boekwerk vormen. Met de juiste opslagmethode wordt het een waardevolle bibliotheek aan onmisbare informatie.

Ik hoor je denken: “Maar dit kost heel veel tijd!”. Met deze gedachte zijn we meteen aanbeland bij de eerste reden om wél documentatie bij te houden.

Iemand achter een computer die o.a. aan het documenteren is.

1.    Tijdsbesparing

Een groot onderdeel van programmeren is het oplossen van bugs. Bugs zijn onvermijdelijk en zelfs de meest getrainde, slimme en getalenteerde developers komen bugs tegen. Als je dan een bug oplost, is het handig om deze oplossing vast te leggen. De kans is namelijk zeer groot dat iemand anders of jijzelf diezelfde bug nog een keer tegen gaan komen. Het wiel hoeft dan niet op nieuw uitgevonden te worden, de oplossing ligt klaar in de documentatie.

Iemand hoeft niet opnieuw op onderzoek uit, dingen uit te proberen, zich het probleem eigen te maken. Diegene kan de instructies volgen en direct daarvan leren. Na de investering van tijd voor het maken van de documentatie, win je het dubbel en dwars terug in de toekomst.

Dit werkt natuurlijk niet alleen voor bugs of problemen, maar ook voor werkzaamheden die maar af en toe terugkomen. In plaats van dat iemand dat moet onthouden of weer helemaal opnieuw moet uitvogelen hoe iets werkt, pakt diegene de documentatie erbij en worden deze werkzaamheden weer op dezelfde manier uitgevoerd.

Duidelijke en consistente documentatie die goed is bijgehouden bespaart dus tijd omdat je een heldere database maakt waar iedereen, altijd, op kan terugvallen. Hier profiteren klanten van omdat werkzaamheden minder tijd kosten. Door tijd te nemen om interne documentatie aan te leggen en te onderhouden, verzeker je jezelf ervan dat jouw collega’s en jij op de meest efficiënte en effectieve manier te werk gaan.

2.  Kwaliteit

Efficiëntie en effectiviteit is geen doel op zich, want bij het leveren van producten of diensten draait het uiteindelijk om de kwaliteit. Omdat dankzij interne documentatie processen en procedures vastliggen en iedereen dezelfde stappen volgt, garandeert documentatie ook dat elk afgeleverd product of dienst van dezelfde kwaliteit is en aan dezelfde standaarden wordt gehouden. Zo krijgt een klant altijd de kwaliteit die hij verwacht en verdient bij de producten of diensten die hij afneemt.

De documentatie biedt mensen een referentiekader. Het geeft ze accurate en up-to-date informatie die ze nodig hebben om hun werk correct uit te voeren, waardoor het aantal fouten ook zal verminderen. Ze zullen beter geïnformeerd wat ook de procesverbetering ten goede komt.

3.  Procesverbetering

Als processen gestandaardiseerd zijn, zorgen ze ervoor dat iedereen dezelfde methodes en werkwijzen gebruikt om bepaalde dingen aan te pakken. Dit voorkomt onzorgvuldigheden, inconsistentie en vertragingen die allemaal een negatief effect kunnen hebben op de kwaliteit en de efficiëntie. Zo is Before Sales het projectplan voor het maken van een website aan het standaardiseren en zelfs in een digitale vorm aan het gieten. Hiermee besparen wij onszelf en de klanten tijd, omdat het ervoor zorgt dat wij alle benodigde informatie al van tevoren hebben, en er niet nog vaak overheen en weer gemaild hoeft te worden.

Als mensen goed geïnformeerd en ingewerkt zijn in hun werkzaamheden, zullen ze ook sneller verbeterpunten aandragen voor verschillende processen. Door regelmatig de documentatie erbij te pakken, kunnen teams problemen, conflicten en inefficiëntie binnen het proces makkelijker identificeren en aanpassen. Op het moment dat processen op één plek in de documentatie bijgehouden worden en daar vastliggen, hoef je ze ook maar op één plek aan te passen om een verbetering door te voeren, iedereen kan er meteen bij en werkt vanaf dat moment ook met het verbeterde proces. 

4.  Samenwerking

Samenwerken volgens dezelfde processen of werkwijzen en het samen identificeren van eventuele problemen of verbeteringen, schept een band. Documentatie helpt daadwerkelijk bij het teamgevoel en de saamhorigheid! Verantwoordelijkheden liggen duidelijk vastgelegd, en men weet wat er verwacht wordt. Hierdoor wordt ook voorkomen dat werk dubbel gedaan wordt. Communicatie wordt duidelijker, omdat iedereen dezelfde informatie voor zich heeft, en toegang heeft tot dezelfde kennis. De gehele collectie aan documentatie vormt een waardevolle kennisbank, voor mensen die er al heel lang werken, maar ook voor nieuwe collega’s. Dit voorkomt onderlinge frustraties, en vergroot het werkplezier. Dit straalt af op de producten, diensten, en op de klanten.

5.  Personeel

Iedereen die met personeel werkt kent dit probleem: je hebt eindelijk die vacature ingevuld, maar je hebt helemaal geen tijd om diegene in te werken. Hoewel je nooit helemaal onder het inwerken uitkomt en het belangrijk is om nieuwe collega’s een warm en persoonlijk welkom te geven, biedt goede documentatie hier ook een uitweg in. Met duidelijke omschrijvingen kunnen mensen taken oppakken die ze nog nooit eerder gedaan hebben, en deze wel naar de kwaliteitsstandaarden uitvoeren. Klanten zullen op deze manier niets merken van personeelswisselingen of het feit dat iemand anders dan ze gewend zijn een keer werkzaamheden voor ze uitvoert, de kwaliteit blijft net zo hoog.

Goede documentatie is eigenlijk een groot handboek van hoe alles in het hele bedrijf werkt, inclusief hoe nieuwe medewerkers aangetrokken en ingewerkt moeten worden. Alle processen kunnen geoptimaliseerd worden, van de sollicitatieprocedure, tot een fijne werktijd, tot aan pensioen of ontslag.

6.  Kennisbank

Om het kennisniveau binnen een bedrijf hoog te houden kun je al je collega’s op dure cursussen sturen, maar je kan ze ook van elkaar laten leren. Documentatie bijhouden helpt daarbij. Zeker bedrijven die al langer bestaan, hebben al een grote en waardevolle kennisbank opgebouwd, met nieuwe en moderne kennis van de jongere collega’s die er minder lang werken, en de waardevolle ervaringen en kennis van collega’s die al langer in het vak zitten. Hiermee wil ik niet zeggen dat externe scholing onbelangrijk is, maar de combinatie van zowel interne documentatie als educatie buiten de deur, zorgt ervoor dat iedereen op de top van zijn kennis in kunde zit.

Mensen zijn soms bang dat ze minder waardevol zijn op het moment dat zij hun kennis delen, en deze dus niet meer uniek voor hen is. Uit een enquête bleek dat wel 60% van de onderzochte werknemers moeite hadden om waardevolle informatie uit hun collega’s los te peuteren. Informatie die zij wel nodig hadden! Als het de norm wordt om kennis te delen, ondervindt iedereen de voordelen van een transparante werkwijze en een betere samenwerking. Leer van elkaar. Daar wordt iedereen, het bedrijf, en de producten en diensten beter van.

7.   Certificering

Certificering, audits. Deze woorden roepen meestal dezelfde geluiden en hetzelfde sentiment op als documentatie schrijven. Maar documentatie maakt het leven juist bij certificering en audits makkelijker! Om dingen te bewijzen moet je nu eenmaal dingen vastleggen. Op het moment dat jij al een goede documentatie hebt geschreven en je besluit als bedrijf om voor een bepaalde certificering op te gaan, is de kans groot dat je de meeste informatie al hebt liggen.

Op het moment dat de bedrijfscultuur al zo ingesteld is op het bijhouden en verbeteren van de documentatie, zal ook het behouden van de certificering, keer op keer, jaar na jaar, geen uitdaging meer zijn. Certificeringen zijn een toegevoegde waarde voor je bedrijf, omdat je op deze manier aan de klant bewijst dat je aan bepaalde voorwaarden voldoet.

Tegenargumenten

Zijn er dan ook redenen om niet te documenteren? Uiteraard, en die zal ik dan nu ook eerlijk vermelden.

  • Het kost tijd. En daar valt eigenlijk weinig tegenin te brengen. Documentatie schrijven kost tijd. Exacte cijfers over hoeveel procent van een project je ermee bezig bent, zijn er niet. Je bent er echter niet in vijf minuten mee klaar. Het aanleren van een documentatiecultuur, het implementeren van een goed documentatiesysteem en het up-to-date houden zijn allemaal investeringen in tijd die zich later dubbel en dwars terugbetalen, maar je bent de initiële tijd er wel aan kwijt.
  • Er is gebrek aan urgentie. Soms wordt het belang van documentatie gewoon niet ingezien. Nu hoop ik met dit artikel uitgelegd te hebben waarom het wél belangrijk is. En hoe eerder je ermee begint, hoe sneller je er voordeel uit haalt!
  • Het is inflexibel. Documentatie zou zorgen voor rigide werkwijzen en creativiteit en flexibiliteit in de weg staan. Werknemers zouden het gevoel hebben dat ze niks in kunnen brengen omdat alles al vastgelegd ligt. Daarom is het van belang om documentatie wel regelmatig te herzien, zodat het regelmatig kan worden verbeterd.
  • Het is onveilig. Uiteraard is het van belang om digitale veiligheid goed op orde te leggen. Als er geheime, vertrouwelijke of kostbare informatie gedocumenteerd moet worden, zijn er verschillende tools, mogelijkheden en beveiligingsmechanismen om te zorgen dat deze informatie alleen door de gemachtigde personen ingezien en gewijzigd kan worden.
  • Het is inaccuraat. Dingen vastleggen die vaak veranderen heeft geen nut, omdat het alweer veranderd is op het moment dat iemand de documentatie raadpleegt. Het is inderdaad belangrijk om te kijken wát je vastlegt, en hoe je dat bijhoudt.

Wat is goede documentatie?

Voor het maken en bijhouden van interne documentatie zijn er een aantal “best practices” aan te houden:

  1. Bepaal wat er gedocumenteerd moet worden. Begin bij het definiëren van welke processen, procedures en activiteiten er vastgelegd moeten worden.
  2. Hou het georganiseerd. Zorg dat mensen er goed in kunnen zoeken, dat documenten op een logische plek zijn opgeslagen.
  3. Maak het toegankelijk. Mensen moeten er snel en makkelijk bij kunnen op het moment dat ze het nodig hebben.
  4. Houd het up to date. Bekijk de documentatie regelmatig en beoordeel of deze verbeterd of aangepast moet worden.
  5. Train collega’s en medewerkers in hoe zij de documentatie moeten gebruiken, bijhouden en zelf schrijven.

Handen en documenten ter illustratie van een brainstorm over hoe documentatie in te richten.

Tot slot

Documentatie heeft heel veel voordelen. Het bespaart tijd, houdt de kwaliteit op peil, processen worden geoptimaliseerd, het bevordert de samenwerking, maakt het inwerken van personeel makkelijker, is een toegankelijke kennisbank voor iedereen en maakt het behalen van certificering behapbaar. De tijd die je erin moet investeren verdien je dubbel en dwars terug, alle aspecten van de bedrijfsvoering hebben er voordeel aan, het is makkelijk aan te passen of up to date te houden en goed te beveiligen. Intern heb je er ontzettend veel plezier van en dit zal zich uitbetalen in klanttevredenheid. En daar draait het uiteindelijk om toch?

Tekst: Anoek de Lange

Bronnen:

Meer blogberichten

29 maart 2023Specialisme

Kan ik een koppeling maken tussen SAP Business One en mijn CMS?
Vera Best aan het werk

24 maart 2023Over Before Sales

Vera Best, even voorstellen…

6 maart 2023Over Before Sales

Matthias Benschop, even voorstellen…