Documenteren kun je leren!

Braindump over informatiestrategie

Ton Zijlstra riep laatst iets over het al dan niet installeren van Nextcloud voor notities. In die post heeft hij het ook over zijn informatiestrategie en linkt hij naar eerdere posts over hoe en waar hij notities maakt(e) en zijn ideeën over informatiestrategie, die ik absoluut als leesvoer kan aanraden.

Met name zijn geschiedenis van blogs, wiki's en andere manieren om gedachten te ordenen en te uiten heeft me een beetje aan het denken  gezet. Tijd om eens op een rijtje te zetten wat ik zoal aan informatie verzamel en genereer, en waar ik dat laat (of zou kunnen laten), deels voor mezelf, deels Omdat Iemand Er Misschien Wat Aan Heeft™.

Dit is een brain dump met bepaalde onderliggende ideeën die langer houdbaar zullen blijken, maar het zal vooral een momentopname zijn.

Must-haves

Los van de plaats of oplossing die ik kies, zijn er een paar eisen waaraan een eventuele oplossing moet voldoen.

  • Cross-platform - ik wil zowel op een computer (ongeacht OS) als op een telefoon (Android, in mijn geval) bij mijn gegevens kunnen. Bonuspunten als dat ook via een terminal kan, maar cross-platform apps of een goede, responsive webapp zijn essentieel.
  • Leesbare data - in noodgevallen moet ik de data ergens in een tekst-editor kunnen lezen. Dit geldt niet voor alle informatie, maar voor naslag is het bijvoorbeeld wel erg belangrijk - als ik notities heb over de inrichting van mijn server, dan moet ik die ook kunnen lezen als de server in kwestie op zijn gat ligt. Dat betekent dat ik opslag in een database zoveel mogelijk vermijd, aangezien dat vaak wat meer voeten in aarde heeft op het gebied van backups en een eventuele restore. Een sqlite-database is nog acceptabel, maar ik prefereer voor de meeste dingen gewoon platte tekst of Markdown.
  • Niet (remote) cloud-based - ik wil niet dat mijn informatie her en der bij allerlei partijen rondslingert. Externe cloud-oplossingen gaan ineens geld (of veel meer geld) vragen, gaan ten onder, hebben datalekken, besluiten dat mijn informatie interessant is voor andere partijen, noem maar op. Als een oplossing niet kan synchroniseren met mijn eigen Nextcloud, heb ik er geen belang bij.
  • Bij voorkeur open source - vooral het vorige punt dwingt dit vaak al af. Het is geen absolute must, maar wel een sterke voorkeur.

Verschillende soorten informatie

Gedurende de dag komen er uit allerlei bronnen allerlei soorten informatie los. Dat kunnen ideeën zijn die ik zelf heb, die in een groeps-chat langskomen, of in een RSS reader, of als toevallig bijproduct van het lezen van websites en documentatie. Sommige informatie is niet lang, of überhaupt, belangrijk, andere informatie is niet nu maar in de toekomst misschien wel belangrijk, sommige informatie is niet zozeer belangrijk maar wel handig als naslag. Soms is informatie tijdgebonden, soms niet.

Dat betekent dus ook dat er niet één sluitende manier is om al die informatie te bewaren. Ik heb daar wel langere tijd naar gezocht, vooral om niet het overzicht te verliezen of eventuele samenhang te missen, als die er zou zijn. Maar een echte one size fits all bestaat voor al die informatie niet. Een herinnering om hondenvoer te halen omdat het bijna op is, is nou eenmaal van een ander kaliber dan een verzameling howto's en documentatie over systeembeheer en virtualisatie, om maar iets te noemen.

Naast boodschappenlijstjes en documentatie hou ik (onder andere) ook nog een leeslijst bij van artikelen, blogposts en andere dingen die ik tegenkom, maar op dat moment nog niet direct kan lezen, of die ik later in een blog wil verwerken. Ik verzamel recepten. Ik documenteer projecten die wat langer lopen en uit meerdere stappen of onderdelen bestaan, en een groeiend overzicht van wat er zoal aan computers en andere apparatuur bij ons in huis slingert, compleet met netwerkinformatie (waar relevant), serienummers, handleidingen, enzovoorts.

Verschillende soorten opslag

Bij die verscheidenheid aan soorten informatie past dus ook een verscheidenheid aan manieren om die informatie vast te leggen.

Ouderwets met pen en papier

Stiekem nog steeds een fijna methode voor korte notities en kleine schetsjes. De houdbaarheid is in theorie prima, natuurlijk, want papier gaat nergens heen, maar omdat je er niet makkelijk doorheen kunt zoeken is het niet echt iets voor lange termijn. Ik gebruik het vooral tijdens telefoongesprekken en voor korte-termijn-actielijstjes.

Op mijn blog

Ik doe het veel te weinig (en probeer het nu wat meer te doen), maar Het Blog is natuurlijk een prima plek om informatie te dumpen die openbaar is (of kan zijn), die lange tijd relevant blijft, en die misschien zelfs voor een ander ook nog interessant kan zijn. Deze post valt daaronder, uiteraard. Maar om iets op het blog te kunnen plaatsen, moet het al wel een beetje uitgekristalliseerd zijn. Een rits URLs van server- of IOT-gerelateerde tools en projecten heeft nog wat liefde nodig voordat ik dat de wereld inslinger.

In een app zelf

Ik gebruikte dit voorheen nogal vaak, en ik kom er steeds meer van terug. Een bepaalde toot op Mastodon favoriet markeren, een browser-bookmark, een post in de RSS-reader markeren: het is allemaal bedoeld om "er later nog eens op terug te komen", en dat gebeurt dus eigenlijk zelden. Als ik bijvoorbeeld mijn RSS-reader opentrek, is dat meestal omdat er nieuwe content is, niet om nog eens terug te komen op iets van een maand of wat geleden - want zo lang blijft het er wel hangen. De oudste post met een sterretje in de RSS reader is momenteel van een jaar geleden, om even een beeld te geven. Het is wel een hele snelle methode om even iets te markeren, maar erg effectief is het voor mij niet.

Sowieso is het sterren van een post in de RSS-reader vaak een teken dat ik eigenlijk gewoon een blogpost erover wil schrijven, en dat zou moeten doen in plaats van dat op de lange baan te schuiven, verdorie.

In een to-do-lijst

Hier heb ik er meerdere van versleten, en hier en daar gebruik ik ze nog steeds wel. Vooral voor een boodschappenlijst is het handig, en die stal ik tegenwoordig in de ingebouwde boodschappenlijst-functie van Home Assistant.

Eerder gebruikte ik Simpletask, die synchroniseerde naar een todo.txt-bestandje op mijn Nextcloud. Dat werkte geniaal voor een lijstje dat ik vooral op mijn mobiel benaderde, en met de onderverdeling in projecten en contexts kon ik makkelijk boodschappen groeperen.

Voor werk- en andere projecten gebruik ik soms nog wel een paar to-do items in Thunderbird, waar het deel uitmaakt van een kalender die weer naar Nextcloud gesynchroniseerd wordt (en dus cross-platform is). Dat synchroniseren via CalDAV is op zich mooi, maar het nadeel is dat zo'n beetje elke applicatie weer zijn eigen implementatiedetails heeft, en bepaalde dingen dus niet overal hetzelfde werken. Sub-items, categorieën, een extra beschrijving bij een item, items op het handje van volgorde kunnen veranderen: het is altijd een beetje een gokje wat er wel of niet ondersteund wordt, en dat staat me een beetje tegen.

In een digitale agenda

Naast afspraken, zijn agenda's ook prima geschikt om dagplanningen in te blokken of notities op een bepaalde dag op te slaan. Voor mij is het uiteraard belangrijk dat zo'n agenda ook via CalDAV te synchroniseren is met de Nextcloud-agenda. Op het werk gebruik ik meerdere agenda's voor planning, afspraken, vrije dagen, enzovoorts, en die zijn waar relevant ook gedeeld met collega's.

In de Notities-app (in Nextcloud)

Doorzoekbaar, platte tekst (Markdown, eigenlijk, maar plat genoeg), wordt automagisch naar meerdere apparaten gesynchroniseerd: voor allerlei langer bewaarde items is de Notes-app in Nextcloud best bruikbaar. Je kunt beperkt gebruik maken van opmaak, je kunt notities beperkt onderverdelen in categorieën (maar niet in subcategorieën). Ik heb hier in de loop der tijd vooral notities, recepten en leeslijsten en linkdumps in ondergebracht - dat laatste was ook erg makkelijk doordat ik vanuit Android direct een link of tekst naar de Android-versie van de Notes-app kon delen.

Op den duur begint echter het gebrek aan ordening zich wat te wreken, en heb je gewoon een Hele Lange Lijst Met Titels staan. Notities in categorieën verdelen helpt iets, maar sommige notities zouden onder meerdere categorieën vallen, en die mogelijkheid is er niet. Samen met de wat summiere opmaakmogelijkheden heeft dat ertoe geleid dat ik verder ben gaan zoeken.

In de Deck-app (in Nextcloud)

Je zou bijna gaan denken dat ik een Nextcloud-fan ben. Deck is in de afgelopen twee jaar behoorlijk in functionaliteit gegroeid en heeft een Android-app gekregen waar je absoluut niet mee voor schut loopt. In Deck kun je één of meer Kanban-boards bijhouden, vergelijkbaar met Trello. In een recente update van de Android-app is het delen van een link of tekst naar een nieuwe kaart sterk verbeterd, waardoor het ook als reading list kan worden gebruikt.

Voor kleinere taken is het minder geschikt (want ietwat omslachtig), maar voor projecten of dingen die een onderlinge samenhang of volgorde hebben is het wel handig.

Het nadeel van deze app is dat de data in een database wordt opgeslagen. Maar aangezien ik mijn Nextcloud intussen redelijk als kritieke infrastructuur beschouw, zit die goed in de backups en is het zo'n ding dat al vrij snel weer in de lucht zou moeten zijn na een calamiteit.

In Bookstack of een andere Wiki-achtige

Op het werk hebben we iets meer dan een jaar geleden Bookstack in gebruik genomen om alle documentatie in onder te brengen. Dat werkt voor een groep mensen, waarvan een deel wisselt omdat het stagiairs betreft, best prettig. Je kunt je informatie redelijk onderverdelen in boeken, hoofdstukken en pagina's en lees- en schrijfrechten daarop instellen. Je kunt tags aan dingen hangen, plaatjes en schema's toevoegen, je kunt zoeken, en de tekst-editor is ook voor minder geoefende gebruikers prima bruikbaar. Je moet wel een beetje bovenop de ordening en consistentie zitten, want er is (nog) geen sjabloon-functionaliteit. Grootste bezwaar dat ik tegen Bookstack voor persoonlijk gebruik heb, is de absolute afhankelijkheid van een MySQL-database. Als je daar niet huiverig voor bent, is het absoluut een aanrader.

Andere wiki's of wiki-achtigen hebben vaak als nadeel dat ze ofwel database-afhankelijk zijn, of niet cross-platform, of niet makkelijk te synchroniseren tussen apparaten.

In Joplin

Joplin is voor mij een redelijk recente ontdekking, en wordt vooral als alternatief voor Evernote opgevoerd. Het is er voor alle relevante platforms (tot en met terminal aan toe, en tekst bewerken op mobiel is niet volledig ruk). Tekst wordt als Markdown bewaard, maar dat is wel een veel uitgebreidere variant dan die in de Nextcloud Notes-app wordt gebruikt, compleet met tabellen, schema's en inline afbeeldingen. Je verdeelt notities onder in notitieboeken, die je ook onder andere notitieboeken kunt laten vallen. Synchronisatie gebeurt via Nextcloud (uiteraard, zou ik bijna zeggen).

Ik heb het een tijdje wat niet-te-serieus uitgeprobeerd als alternatief voor Notes, inclusief de rommelige indeling, en dan haal je er lang niet uit wat erin zit. Ik ben intussen bezig om de inventaris van alle computers en huishoudelijke apparatuur over te zetten (en waar nodig uit te breiden), en dan is het kunnen gebruiken van sjablonen wel erg prettig. Ik kijk ook uit naar het documenteren van de server en home automation, voor zover dat geen publiekelijk toeganklijke informatie is die op het blog kan staan.

Nadeeltje: de tekst wordt weliswaar als Markdown opgeslagen, maar vanwege alle metadata die wordt bewaard, zijn de bestandsnamen nogal onhandig (als in "een brij letters en cijfers") en het wordt ook afgeraden om direct in die bestanden te gaan zitten bewerken. Voor naslag in noodgevallen is dat nog niet het grootste drama, zolang ik een bak tekstbestanden heb waar ik grep op kan loslaten, kom ik er wel uit.

Een ander nadeeltje is de beperkte mogelijkheid om te delen. Je kunt individuele notities wel omtoveren in een een deelbare link, die dan naar een beperkte HTML-render van de notitie wijst. Het werkt, maar het is totaal niet geschikt om met meerdere mensen aan te werken. Desondanks voelt het wel aan als een blijvertje.

Kortom...

Zo, dat was een behoorlijke lap tekst over lappen tekst, en dan is het eigenlijk nog vrij oppervlakkig gebleven. Ik heb nog niet eens alle soorten informatie gehad, en ook alleen maar gekeken naar "waar zet ik het neer", niet eens over het stukje "en wat doe ik er dan vervolgens mee". Ik zie dat in de komende tijd nog wel in één of meer aparte artikelen aan bod komen, maar dan is de basis in ieder geval alvast gelegd. Wie weet (hopelijk!) heeft iemand anders er ook nog wat aan, maar voor mezelf was het in ieder geval wel interessant om eens wat uitgebreider stil te staan bij mijn persoonlijke informatiestromen.

Foto: Jan Kahánek