The article mentions, but doesn't elaborate, on the purpose of the notebook as a legal document. This was much more important when notebooks could be used to show priority in patent disputes, but only if well kept. My parents were both research scientists. Where my dad worked, the company patent lawyer read and critiqued your notebooks, and maintained the discipline.

Many of those rules became unnecessary when the US patent system joined the rest of the world by adopting "first to file" priority. Rules such as: Always writing in pen, and crossing things with a single strike-through.

Notebooks are still a great way to preserve the little details of "what the hell was I thinking?" A colleague told me a good notebook prevents you from having to repeat a study because you can't figure out what you did the first time.

There are still industries that require legally defensible record management -- you'll know if you're in that boat. If not, you can DIY whatever method works for you. The success metric is if you actually use it. On paper, I write in pencil because I'm more concerned about readability than a precise narrative. On the computer, Jupyter, just because nothing else really lets me document "thinking in code."

I have seen meticulous, beautiful lab notebooks before. Paper ones. With numbered oversize greenish pages, faintly quadrille ruled, filled with exceptional INK penmanship, paragraph after paragraph of cogent technical observations, theoretical musings, responses to papers, thought-experiments and real experiments, taped graphs and images. Everything dated and signed. I've seen stacks of them spanning YEARS of work.

I tried. Mine look like shit. If it's in ink, it's peppered ALL OVER with correction after correction after correction. Perhaps it's a matter of practice, but then I've not been at one place long enough where projects weren't constantly re-shuffled, killed, or lasted long enough to get a grip (sometimes the job and the company itself doesn't even last long enough).

Perhaps these are becoming a relic of a lost era? Paper is too much of an "air-gap" when everything is done on computer. Moreover, the standard 2-week Agile "sprint" leaves no time for careful thinking and writing. One can't put epiphanies gained from writing up notes into "the deliverable" for a freaking Jira Ticket.

I recommend the Leuchtturm 1917 Notebook for this kind of stuff. It comes with spine labels and a table of contents pages in the notebook already, and the paper is extremely high quality. They're the perfect daily-use notebook, IMO.

The main problem with paper is that it's not searchable, so I've been using [0] since 2018. Each invocation just appends a timestamped line of text. I have a crontab that pops up a box every hour and I type in what I'm working on. Sometimes I'll add extra notes if I'm working through a particularly thorny problem. It's always right there on the terminal.

I'd say it's saved my ass at least a dozen times over the years, where I hit a problem that I've seen before but can't quite remember how to solve it. I also page through it quarterly to get a good summary of what I've worked on for that quarterly 1:1 with the boss.

[0]: https://gist.github.com/mfischr/f1ee2967ec0181b934639c30f4e6...

I've started writing a markdown file every day, with a separate heading for each project, and a tool that automatically creates an index page that says what topics (based on headings) were present each day.

Apart from the format of the headings, it is deliberately informal and unstructured. I've found it very useful.

One advantage of lab notebooks that the article does not mention is that by design, the pages are firmly bound to the book, so you cannot lose them. I started to use lab notebooks because I would otherwise just write thoughts on loose-leaf paper and have a difficult time keeping track of the pages and their order. The lab notebook (or any notebook with firmly bound pages) solves that problem.

That said, I don't use lab notebooks for coding/software development. I tend to use Markdown files in a Git repository for that. That setup serves the same purpose, since I write down what I intend to do and whether I was able to achieve it or not, but it is much easier to use when coding in my experience.

Habit of lab notebook has stuck with me since college. Shoutout to reMarkable tablets and Neo Smartpens, for helping combine the analog process of handwriting with digital search. Likely a personal thing, just like to take hands off keyboard from time to time. Seen hints of research re benefits of handwriting, but never really dug into it.

I have started using Obsidian for daily notes (which you can categorize better than the default so it's more findable) and you can tag / create back links. I am thinking that these tips plus the tools Obsidian provides would make an excellent combo. Then the files can also be placed in git and backed up for protection!

Lab notebooks have saved me many times. The days run together in experimental work and having a record of what I tried or saw and on what day has paid off weeks or months later when a collection of observations snapped into focus. Never been able to keep a table of contents, though.

I wonder if we soon will get wearable lab cameras/microphones that can log what you do while keeping your hands free. More than once, I have been working with both hands and suddenly been distracted for a brief moment just to discover that I no longer remember if I really added stuff to that well. Also, having more exact timestamps at each stage of an experiment might be useful for later

We call them “Engineering Notebooks” and after 5 years at a company they tell an interesting story of the projects worked on. I’m often reviewing notes from the past couple of months and occasionally have to go back a year or two to dig up some information that I know is there somewhere.

Highly recommend Muji’s gridded notebooks (€1.95 for A5-size, 30 sheets):

https://www.muji.eu/product/recycling-paper-notebook-dark-gr...

I know of two places to buy genuine engineering lab notebooks, for anyone interested.

1. Scientific Notebook Company <https://snco.com/>

2. BookFactory <https://www.bookfactory.com/>

Of the two, I slightly prefer BookFactory's offerings. Note that there are many, many variants. Unless you are employed somewhere that mandates a particular type – and if you do, they are likely available from your office supply closet – pick one you like. Do go with the bound hardcover style, though. They're much more durable than spiral or softbound.

I'll probably just use an app, rather than real paper, but I'll definitely keep this in mind next time I'm doing something experimental and not just "Stuff copilot could probably do".

Preserving a record in detail seems like a natural fit, we're used to doing the same for our source code, I'm surprised it's not more common to do the same for the source of the source code.

I started working at a lab where I am the only SWE and everyone else is a scientist. I have a lab notebook, but I don't use it properly (thankfully nobody gets on my case about it). I usually just use it as a short-term working memory, but it helps me keep track of the progress I've made. It's nice to look back on something I was working on two months ago and see all my thoughts written down about which library to use or architecture to use. Looking back at my past struggles gives me a sense of accomplishment and progress.

That said, I usually try to preserve the results of my "experimentation" in documentation with the software, so I can share it with others. It's a good sign when people never talk about X to me, and I end up asking them if they ever used X and they tell me "I just used your documentation". Best feeling ever.

One issue is whether to organize lab notebooks by project, or by time. In the latter case, this means the notebook is a record of your day-to-day activity, which has certain advantages (like having a single record to refer to), and disadvantages (reconstructing a project's timeline can be time-consuming if you're working concurrently on different projects). A decent compromise is to have a daily notebook, but never put work on two projects on the same page. Then if you really want to reconstruct a project's history from the daily journal, you can at least just copy pages.

The primary reason for having a lab bench notebook is that, if properly used, you can always reconstruct the process you were documenting. A lot of bench research involves protocol development, for example. In comparison with software engineering, a protocol is like an algorithm, only you're applying it to physical samples. In a well-run lab, once someone has developed a protocol, they 'publish' it (stick it in the lab's manual of protocols, where other people can have access to it). So, you don't share your lab notebooks with others, you share the completed protocol, and then if there's some question about if the protocol can be improved, you can go back to the lab notebooks to see what was already tried (this seems similar to software library or device driver development).

Some people don't like lab notebooks much, because properly recording what you did in enough detail that you can go back and repeat it eats up time and requires a certain discipline, and it often takes some unfortunate catastrophe (comparable to losing all your data backups) to learn the value of the practice.

Incidentally, if a research lab, public or private, has no guidelines at all on lab notebook practices, it's an indication they may be engaging in shady behavior (e.g. Theranos) - it's comparable to a crypto exchange outfit like FTX not having an accounting division, and should be a red flag for investors. This is also a reason for the ink-only rule, with pencil you can go back and fudge data more easily.

Does anybody have a reference/example of a lab notebook for software engg ?

If I'm forced to log my thoughts/actions it comes out as either too terse(everthing feels obvious) or it's too verbose and it's often difficult to find the right balance.

A huge downside of writing this down on paper is team collaboration. Imagine that instead this is kept in a tool like Notion which the entire team can access. At first this feels incredibly uncomfortable - your notes are there for everyone to see. However it’s a massive force multiplier because often the work is picked up by someone else later on, and instead of asking you they can self-serve. It’s pretty common that by the time they need it you would no longer be at the company.

I don’t have experience writing in a lab journal format, but for documents like growth experiments and how they worked, or RFCs, this is a godsend. It takes a lot of work to keep it tidy, but it’s worth it.

It reminds me an approach to data science and ML. It's way more common and essential for ML teams to log their attempts (experiments). There is a whole set of tools for this - experiments trackers. Primarily to even being able to compare and pick the best direction, but also to ensure reproducibility (in some areas it might be required).

ML/DS always seemed to me closer to science in its nature vs software engineering. Can be because of its nature as well - in a lot of cases it's a process of incremental improvements (vs - simplifying this a lot - let's say in SE we do a button that just works or not).

I do this for my personal software projects, research or otherwise. I have more stricter rules about paper and pen I use though.

A single fountain pen, filled with the same permanent, pigment or cellulose reactive ink, on a hardcover, ink-safe notebook.

However, the rest “at the speed of thought” rules are almost the same. Theorize, design and detail on paper, implement, document results, GOTO 10.

It’s a greet speed regulator, clarifier and keeps everything documented. As a bonus, you get “That weird guy” merit badge, which I don’t care.

I always have one of more pages of loose-leaf on my desk. It’s messy, but basically the lowest barrier to entry. And if I’m somewhere else and write something down, it goes in the pile with the other notes when I get back.

A few times a year, I open an org-mode file and start summarizing my notes. Those sheets then get put away, to help keep things a little less messy.

I use lab notebook inspired process to share information across our engineering organization. It is like your daily standup, but written throughout the day.

https://bobek.cz/blog/2021/written-standup/

I use lab notebook inspired process to share information across our engineering organization. It is like your daily standup, but written throughout the day.

https://bobek.cz/blog/2021/written-standup/

100% yes.

And a new page per day (paper is cheap), with the date always on top outer corner of the page. Never share a page across dates.

Thoughts, however bizarre, around the topics are very useful. Elaborate where possible. Names, keywords and classifications will be useful later, so do consider the future as you write.

I get these, modified to be regular notebooks, from https://snco.com/

You can get them custom printed with whatever paper you like, custom names, titles and numbering on the books, for no more cost than a regular notebook.

Haven’t heard of Neo before but it looks amazing. Could you explain your process and likes/dislikes with the Neo/reMarkable?

Absolutely not. My working / lab notes capture raw thoughts, often abbreviated and with shortcuts taken. Others would have trouble gleaning much meaning from them, with so many scratched out words, wildly drawn arrows, and peculiar diagrams.

Take my raw notes, rewrite them for another audience, and post those on Notion? Maybe. But it's likely a different document (an essay, tutorial, FAQ) could be rewritten out of my notes, one which would be more useful for my teammates.

I agree with having shared team documentation but this has always been gray for me. My notebook ( and my softcopy log for the week) are incredibly raw (one-lines through mistakes, my personal commentary/snark, "napkin math",etc.). I am willing to share them with teammates/our lead/ or whoever may benefit but this has backfired on me. We perform analytical verification work and I've seen middling performers on our team look to avoid performing thorough work by copying from the notes of someone else ( I get this is work and not school so typical academic rules don't apply but our work is very investigative/exploratory in it's nature, performing derivations to ensure our approach is correct is encouraged and not considered a waste of time. Also contexts change quickly and a deep understanding is necessary) Thus when someone is trying to take a shortcut it leaves a bad taste in my mouth. Also "micro-managers" see pages of notes open and treat it as fair game to pull up to my desk and expect immediate updates instead of requesting reasonably or waiting for the appropriate forum. I get this is a culture/staff issue more so than other things.

I maintain a daily email to myself in a shared mailbox. I have 3 sections:

SIGNIFICANT

  \* topic1

    \* this happened

  \* topic2

DONE

  \* This project

    \* Made this change

    \* Made another change

  \* Some training

    \* Completed this section

TODO ...

I'm in a setting where I'm incredibly temporary. I could be tasked elsewhere tomorrow. Every day I reply to my previous email and work on the draft throughout the day as my notebook. At the end of the day I send it, received in the mailbox I'm attending. I title the email "Captain's Log" and my supervisor and peers can read it, as well as the draft, whenever. This keeps them clued in on where my head is at, what I'm working on, etc. Great for performance reviews mostly. Not as convenient as something like my Remarkable tablet.

> instead of asking you they can self-serve. It’s pretty common that by the time they need it you would no longer be at the company.

All lab notebooks are company property. You don't keep them locked away in your desk or take them with you when you leave. Any current or future employee with the right clearances should be able to serve themselves to the entire archive. No need to ask the original author.

Searchability is by far the most significant advantage of electronic documents, but you can get pretty far with paper notebooks if you keep a decent table of contents. Even better if you regularly scan, OCR, and upload your pages to the archive. IMO the inconvenience of scanning is greatly outweighed by the paper notebook's guarantee of immutability. Tools like Notion make it too easy to erase information, either accidentally or not.

This is a render-unto-Caesar problem. It all depends on the audience. Here's what works for me.

1. Email is good for sharable things like interview or meeting notes. It's searchable and you can dump it to Google Docs/Notion from the draft if that's appropriate. Using Gmail keeps you from trying to format it too much while writing.

2. My lab book is for me. Writing with pen/paper forces one to sort out ideas up front--not a lot but just enough for them to make sense and be readable later.

It seems as if everyone will have a different take on this.

I agree that it’s useful for the rest of the team to have access to your notes, but I find that it’s far more useful to write my notes with a pen and paper rather than typing them out. It forces me to slow down and think through what I’m doing, in addition to aiding in memorizing the parts of my notes that I find important.