Versatile software engineer with a background in .NET consulting and CMS development. Working on regaining my embedded development skills to get more involved with IoT opportunities.
I keep a development journal when working on difficult things. When I have to figure out the (astonishing lack of) architectual principles behind 10,000 lines of JavaScript, I need my engineer's notebook. When I am modifying my Homelab, I take detailed notes on what I'm doing so I can automate it in the future, remember why I thought something was a good idea when it bits me in the butt in two weeks, and summarize lessons learned.
When I go to someone with my dev journal, it does most of the talking for me. There's references to files so they can see problem areas of code themselves, everything is prioritized and categorized, and it can be passed around with other team members as needed.
I have fallen in love with Org mode in Emacs to track these adventures, but any Markdown editor will due the trick. I like making life complicated :D
I keep a development journal when working on difficult things. When I have to figure out the (astonishing lack of) architectual principles behind 10,000 lines of JavaScript, I need my engineer's notebook. When I am modifying my Homelab, I take detailed notes on what I'm doing so I can automate it in the future, remember why I thought something was a good idea when it bits me in the butt in two weeks, and summarize lessons learned.
When I go to someone with my dev journal, it does most of the talking for me. There's references to files so they can see problem areas of code themselves, everything is prioritized and categorized, and it can be passed around with other team members as needed.
I have fallen in love with Org mode in Emacs to track these adventures, but any Markdown editor will due the trick. I like making life complicated :D
🤩
Your development journal sounds like an amazing piece of documentation. Well done.