Entwicklertagebuch in Visual Studio Code führen

VSCode Journal - Erster Eintrag
Mein erster Eintrag im Tagebuch

Seit sieben Jahren dokumentiere ich meine Entwicklertätigkeiten in einem Tagebuch im Texteditor Visual Studio Code. Dazu benutze das Plugin vscode-journal. Mit der Tastenkombination Command-Shift-J legt mir dieses Plugin eine neue Textdatei im Markdown-Format mit folgender Namensstruktur an:

/.../Text/2024/11/10.md

Das heisst das Plugin erstellt automatisch Verzeichnisse für das Jahr und den Monat, benennt die Datei nach dem aktuellen Tag und öffnet sie im Editor.

Der Inhalt des Entwicklertagebuchs hat sich über die Jahre ausgeweitet:

  • Berufliche und private Programmiertätigkeiten, Systemkonfiguration
  • Kurzfristige Todo-Listen und was als Nächstes ansteht
  • Konzeptionelles, Dokumentations- und Mailentwürfe
  • Private Tätigkeiten (Administrative Arbeiten, Wohnungsunterhalt, Veloreparaturen, Hobbys, Sport, Rätselparcours etc.)
  • Soziales (Treffen, Feste, Mittagessen etc.)

Was sich als besonders wertvoll erwiesen hat: Eine „Nächste Schritte“-Notiz bei privaten Projekten. Wenn ich ein solches Projekt nach Monaten oder gar Jahren wieder in die Finger nehme, bin ich froh über Anhaltspunkte darüber was ich als Nächstes geplant hatte.

Parallel dazu führe ich im /Text-Verzeichnis eine Sammlung von Textdokumenten, PDFs und Bildern als persönliche Wissensdatenbank in einer möglichst flachen Verzeichnisstruktur.

Alle fünf Minuten wird das ganze Verzeichnis via Git automatisch zu GitHub in ein privates Repository commited. Dazu wird aus der lokalen crontab folgendes Skript aufgerufen:

#!/usr/bin/env bash

cd "$(dirname "$0")" || exit

/usr/bin/git add -A
/usr/bin/git commit -m "Autocommit."
/usr/bin/git push

Ich benutze dieses System nur auf einem Computer, deshalb benötige ich nur eine Einweg-Synchronisation. Bei meinen externen Mandaten richte ich mir normalweise ein separates Repository in der internen Codeverwaltung ein.

Der grösste Vorteil ist meiner Meinung nach die Einfachheit der Datenspeicherung: Es handeln sich zum grössten Teil um einfach Textdateien. Keine proprietäre Formate, diese Dateien werden immer lesbar bleiben.

Ein Nachteil hat meine einfache Lösung, besonders im Umfeld des Wissensmanagements: Als einzige Recherchemöglichkeit steht die Volltextsuche zur Verfügung. Was ich mit dieser Suche nicht finde, ist verloren. (Habe ich jetzt den Ausdruck „Aare.guru“ oder „Aare Guru“ oder „Aareguru“ verwendet?) Das System würde zwar Verknüpfungen zwischen Dateien unterstützen, aber nur rudimentär.

Als Alternative empfiehlt sich ein spezialisiertes System wie Obsidian. Dieses speichert (Soweit ich weiss) auch alles als reine Textdateien und bietet Mehr-Weg-Synchronization.

Ich bleibe für den Moment bei vscode-journal. Für eine ausführliche Reflexion über Entwicklertagebücher kann ich diesen Stackoverflow-Blogpost empfehlen.