Live documentation with Obsidian
A problem any developer knows: a software project that lacks documentation. The code might be overcomplicated, and of course the least documented parts of it are changing most often, and thus are more problematic or complex.
Here’s an approach I’ve tried out, and it seems really promising. Live documenting the project with Obsidian notes, a wonderful note-taking app that is based on Markdown, supports cross-note links and can be synchronised over a Git repository.
We will be solving several problems with this approach.
First is that code comments are usually not enough, and also they do not tend to age well. How many of those decade-old TODO
s have you encountered in legacy codebases? How many comments in a codebase make things harder to understand, because the adjacent code was changed, but the comment itself was never updated?
The second one is keeping track of your architecture...