Remix.run Logo
danpalmer 3 hours ago

I was given this advice at university, but what I was always missing was what I was supposed to write down in them.

The post here mentions hypotheses, but I don't do experiments for the most part. It mentions writing down in the notebook before writing code, but I can't test my notes, I can't really send my notes for code review. I guess you could use it for design, but you'd lose all the advantages of word processing such as editing, links, context, etc.

I often have a scratch pad editor around with current working state in – that makes sense to me, but not on paper and that's not what's being proposed. I have also at times kept a logbook of what I've done, but it was very much an end of the day/week summary, not in the moment, not forward looking like this mentions.

The idea sounds great, but what is actually being written down?

analog31 3 hours ago | parent | next [-]

I'm a scientist. In the science world, the traditional lab notebook contained a narrative of what you were doing. You're kind of thinking out loud into it.

One measure of a good notebook is if it contains sufficient information that you don't have to repeat work only because you can't figure out what you did. There are other good reasons for repeating things of course.

My spouse is a lab scientist, and I've seen her meticulous notebooks. She was telling me just last week that one of her experiments produced a puzzling result. The next day she said: "I figured it out from my notebook. I skipped a step that was in the procedure."

There was a time when a notebook was also a legal document, and so there was a criterion of whether it would stand up in court as proof that you had invented something. Could a "person skilled in the art" replicate your work based on your notebook? My dad told me that his notebooks were regularly reviewed and witnessed.

The legal issues have changed, since the patent system has switched to the "first to file" rule. My employer got rid of its formal notebook policy when this change came through.

My problem with physical notebooks is that a great deal of my work is computational, and I automate things. In my case, the best form for recording my work is in fact a Jupyter notebook. On the other hand, I come from a family of chemists, and taking electronic notes in a "wet" chemistry lab is often impractical.

dirkc 21 minutes ago | parent [-]

I also keep a 'lab notebook', but I must admit that a lot of what I used to document in my notes (setting up software/compiling 3rd party deps) I now document in code (scripts, devops, etc).

I still find lots of value in keeping notes though! And sometimes miss it when I didn't keep notes.

kstrauser 3 hours ago | parent | prev | next [-]

I picked up bullet journaling a few years back and that’s how I track my work:

o Sales meeting with Foo Corp

- Suggested to Sam that we use PostgreSQL

- Made us $X by doing $Y (star drawing)

. Fix a thing

/ In the process of fixing a thing

X Done fixing the thing

And that’s about it. I write this in an epaper notebook (Supernote Nomad) that I take everywhere in the office. At a glance I can tell you what I’m working on, what I did, and who I told what. And when I’m writing my annual self-review, I can search it for the star drawings to know what I can brag about.

I specifically do this instead of an iPad because I found it vastly less distracting during meetings. I tend to leave it laying there while I look at the speakers and pay attention, rather than just checking Slack really quickly, and oh, better look at my email, etc.

This is salve for my ADHD-scalded mind.

theamk 3 hours ago | parent | prev | next [-]

I don't have a full-blown notebook, but I keep task notes in individual text files. A sample text might be:

- Fixing broken test: (full ci link)

- seems to be repo foo, target //bar:baz, subtest TestSomethingNice. Error: (30 lines of stack trace here)

- git checkout 0ead3f820da34812089

- trying locally: bazel test //bar:baz

- command failed, error: (relevant error here)

- turns out I need to set a config, reference: (wiki link here)

- trying: bazel test --config=green //bar:baz

- problem reproduces 5 times in a row, seems like 100% fail rate

- source file location: source/bar/baz.cc

- theory: baz is broken from recent dependency bump. Reverting commit 987afd

- result: the error is different now (more error text)

etc.. etc...

This is actually super handy for a complex problem. No need to wonder "did I see the error before?" or "wait, when I was trying that thing, did I see that message as well?" or "how do I reproduce a bug again?". No keeping dozens of tabs open so you can copy a few words from each of them. When later talking to someone, you can refer to your notes.

rtpg 3 hours ago | parent | prev | next [-]

> It mentions writing down in the notebook before writing code, but I can't test my notes, I can't really send my notes for code review.

I think generally it's more about sketching the high level structure of the code. I will routinely write things like :

  documents = ...
  by_client = documents.group_by(client)
  for client, doc_set in by_client:
     for doc in doc_set: csv.write(doc)

Not at all following the actual APIs I use, but I can fill in the blanks when getting the code in place.

The above is very simple, of course, usually I'm working through something where I just want to play through what pieces of data I might or might be missing

theshrike79 38 minutes ago | parent [-]

I've tried that, but my brain is just going "why are you writing about doing the thing instead of, you know, DOING THE THING"?

I vastly prefer just making a working skeleton and filling that with actual code as I progress.

pjot 3 hours ago | parent | prev [-]

For me, it helps to slow down my thoughts and aides deep work. I draw diagrams, connect blurbs with arrows, and “link” to other page numbers.

danpalmer 3 hours ago | parent [-]

This is still missing the "what" for me. What do you write down about the work?

Is it a plan for what you're about to work on? Is it a breakdown? Is it facts you learn as you work through something? Is it a minute by minute journal of what you've done? Is it just interesting details? Is it to-dos? Is it opinions you're trying to clarify?

Diagrams I get, my desk is covered in scribbled diagrams to help me visualise something or communicate it to a colleague.

evnu an hour ago | parent | next [-]

For me, if it's worth thinking about it, it's worth writing it down. Doesn't matter if it's a todo list I just came up with, a system diagram, whatever I am currently working on, or thoughts on a human interaction I just witnessed. The act of writing it down guides me in my thinking.

aylons 3 hours ago | parent | prev | next [-]

Frankly, at the beginning? Anything you feel like. You can start, perhaps, with Just a title of what you're doing, pomodoros style.

Maybe a note of something you thought but couldn't follow up on that moment.

Diagrams are good. Much easier to think and much better and faster doing by hand. I always get distracted by the tool when I'm drawing in a computer. Even artist-modd

I also make bullet points of general ideas that I'm trying to accomplish.

Doodles.

Important thing is, don't fret. Over time you'll find how it works for you.

cratermoon 3 hours ago | parent | prev [-]

Every time you look up something on StackOverflow, refer to the API docs, or refer back to the ticket, use case, or requirements document, make a note of your question and the answer. Even when you stop typing to take a break for a moment, or after pushing code while you wait for the ci/cd pipeline, note down where you are and your last action or change.

Every time you start to write a TODO comment, make a note instead, or also.

Consider Kent’s Beck’s recommendation to write down every decision you make.