5 ms·
If I'm working on something particularly complex I basically just do the journaling in a code comment adjacent to what I'm working on. So the first commit may b
by safety1st 2y ago
If I'm working on something particularly complex I basically just do the journaling in a code comment adjacent to what I'm working on. So the first commit may be three lines of code and a huge long winded rambling comment of what I've already tried or thought about. By the time the task is done I've pared away the more speculative/rambling elements of what I wrote, and what's left is typically some extremely well commented code. I think this method results in higher quality code produced faster than if you just try to keep everything in your head. No one's complained yet...!
- glynnormington 2y agoI like that. There are other ways of capturing work in progress adjacent to the code, instead of writing a journal. One of my favourites is to write a failing test - pretty much impossible to overlook or misunderstand on "re-entry" to the task. Another is to write a temporary commit log, with "WIP" in the first line and a TODO list in the rest of the log. This is good for ephemeral information that would just clutter up the code. If I do need something like a journal, I have occasionally just written a private gist and put that in a tab on my browser.
- safety1st 2y agoThese are really good!
- simpaticoder 2y agoA good technique I've used as well. Call it "iterative literate programming".
- veunes 2y agoAn effective strategy for managing complex tasks