Documentatie?

Hieronder misschien enkele zaken om over na te denken vooraleer je begint met documentatie. Want eerlijk gezegd, ik heb al veel verschillende manieren geprobeerd. En nooit kwam ik tot DE oplossing. Steeds zijn er links of rechts wel zaken die ontbreken. Maar het is altijd goed om je zelf enkele vragen te stellen voor te starten. Goed begonnen is …

Documentatie lijkt in vele gevallen tijdverlies, maar wees gerust, in geval van (zware) problemen zal je documentatie gene tijdsverlies zijn. Maar een zegen uit de hemel.

Op zich is het niet zo belangrijk hoe je doet. Als je het maar doet!


Voor wie schrijf ik de documentatie?

  • Voor jezelf?
    Dan kan je het waarschijnlijk vrij vlug neerpennen, op een eenvoudig kladmanier?
    Fout! Wat vandaag glashelder lijkt, kan binnen 2 jaar compleet anders lijken.

  • Voor anderen?
    Wie zijn dit dan? Gaan zij in staat zijn het te begrijpen?

Waar hou ik dit bij?

  • Gewoon, op je computer?
    Wat als je computer crasht? Heb je een goede, up to date backup?
    En wat als het dringend is? Heb je er dan toegang tot?

  • Op een blaadje papier?
    Heb je hier een kopij van? Wat bij brand, diefstal, omstootkoffie…?
    En wat als het dringend is? Kan je er aan?

  • In de cloud?
    Zijn anderen in staat om hier toegang tot te hebben? Kennen zij de juiste plaats? Moeten ze een wachtwoord hebben?

Wat pen ik neer?

Denk maar eens of jij weet hoe de wasmachine werkt. Simpel toch? Als jij de was thuis doet. Ik ga ervan uit dat de anderen totaal niet weten waar ik met bezig ben, en meestal heb ik hier nog gelijk in ook.

  • Hoe meer je documenteert, des te beter. Ik ga er extreem ver in, maar denk maar aan
    • Je IT-omgeving, netwerk…
    • De verschillende huistechnieken zoals verwarmingsinstallatie, ventiallatie, PV installatie, waterleidingen, afvoeren. Daarnaast de vele app’tjes die ermee gepaard gaan. Hoe kan je ook alweer je zonnepanelen bekijken?

Hoe schrijf je het?

  • Welke software ga je gebruiken?
    Freeware software? Software in de cloud? Professionele software? Denk aan dit alles dat het ‘lang’ moet meegaan. Je wilt tenslotte niet elk jaar al je data overzetten naar iets nieuw?



Wanneer schrijf je het?

  • ASAP !!!
    Hoe vlugger hoe beter. Want vergis je niet. Vandaag ligt het allemaal fris in je geheugen, maar met morgen? Of nog erger, wat als er morgen iets met jou gebeurt? Ga je je nabestaanden met jouw pareltje laten zitten?

  • Regelmatig!
    Dit is ook iets. Neem zelf van tijd tot tijd je documentatie door. Want misschien zijn er wel zaken gewijzigd? Iets dat niet meer bestaat? Of ergens iets toegevoegt?


Voorbeelden

Ik ga proberen om op mijn blog regelmatig een voorbeeld van een document te plaatsen. Misschien krijg je dan inspiratie om zaken te documenteren.


Hoe doe ik het persoonlijk?

  • Persoonlijk schrijf ik de documentatie grotendeels voor mijn gezin. Mocht er ooit iets gebeuren met mij, dat zij tenminste niet het duister tasten. Mijn vriendin is niet technisch onderlegd, dus dan is dit iets waar ik rekening moet met houden.
    Aan de andere kant merk ik ook dat dit nodig is voor mezelf. Dat ik alles ‘eenvoudig’ neerpen. Na 5 jaar een onderwerp niet meer aangeraakt hebben, mis je toch bepaalde details.

  • De verschillende onderwerpen liggen ver uit elkaar. Van hoe ik de waterput meet tot wanneer er bepaalde bomen gepland werden. Technische fiches van bepaalde toestellen tot fiches van huisdieren. Overzichten van verzekeringspapieren, logboek van de woning… Je kan het zo zot niet bedenken, of ik doe het.

  • Al mijn documentatie is te vinden op mijn persoonlijk forum. Dit werkt voor mij handig, en heeft een super zoekfunctie. Nadeel is wel dat dit forumpje altijd up and running moeten zijn. Als mijn netwerk/server/… een probleem heeft, dan heb ik geen toegang tot dit alles!
    Daarvoor print ik ook op regelmatige basis de meeste documenten af. Die dan terug te vinden zijn in een ‘technische’ map.
    Maar dit kan evengoed een cloud storage zijn zoals Google Drive, Onecloud… Als je maar je bestanden vlug kan openen (of bijwerken!)

  • Qua software gebruik ik nog steeds MS Visio. Reden hiervoor is dat ik jaren hierin technische schema’s heb getekend. Dus is eigenlijk gemakzucht.
    Maar ik schakel langzaam over naar draw.io. Dit is een vrij compleet online tekenprogramma waar je zowat alles met kan doen. Zeker de moeite om es te bekijken.

Schuiven naar boven