How to use a journal as a software developer

How to use a journal as a software developer cover image

"Do you know how to get rid of this weird primodials issue?" I was asked across the office once.

Something about it sounded familiar so I did a quick search through my work journal and sure enough unearthed a note from 3 months earlier where I had seen this issue myself and jotted down the solution.

"You're running the wrong node version for that application" I confidently reply.

I looked like a super hero for remembering, when in fact all I did was look back through my external store of knowledge where I jot things down every day and regurgitate it. It helped in this case that the issue had a cool name in it (which is why I use this as my main example) but if it was something I had come across in my career, pretty much any relevant search term would work.

The value in keeping a work journal is huge, here's why.

It's not for you to read

It's tempting to think that a journal is for you to go back and read. In reality it's not, it's a searchable store of knowledge where one of the pieces of information is the date it happened on. Don't worry about making it interesting to read or feel like a story, it's a series of notes, events, error messages and solutions from your day that could be useful in the future.

It's a database

It's really a database, a loosely structured, highly searchable database that enables the value of your developer experience to compound over time. The more you put into it the more valuable it becomes because of how bad our memories are. Each nugget of information makes connections to other morsels of information highlighting links you may have missed. Searching for .htaccess in my database brings up rewrite rules for old projects, reminds me of old projects I had forgotten about and highlights bits of tangential information that can unearth memories, like the terror of ftp'ing on to a live server and hot fixing a PHP bug without a git commit or line of yaml insight, good times!

It gives you confidence

We often forget how far we have come, we focus on our current point in space and time, rather than the line and trajectory we are on. Having a store of knowledge, no matter how disorganized and seemingly disparate, lets us see how far we have come, how many problems we have solved and struggles we have overcome.

As digital creators much of our work is invisible 🙁

When my wife sees a car from particularly high end sports car company drive past she is reminded of the work she put into that car's development, when my friend drives over certain bridges he can see the physical manifestation of his work.

I on the other hand don't see the database migrations or api rewrite that took months of my time at my first job. I can, however look at my journal and see the things I learned, techniques I mastered and best practices I applied during that work because I noted it all down.

Anything will do

Don't sweat the tool you use, text files work fine if you have a good way to search them. Notion is my favorite app of choice at the moment. Evernote was all the rage for a few years there and now Obsidian is the new king in town. So long as it's quick to jot something down, has good search and doesn't get in your way then it's good enough to get going with!

So, go forth and journal!!

  • About
  • Blog
  • Privacy
Looking to email me? You can get me on my first name at allthecode.co