使用工程笔记本
Using an engineering notebook

原始链接: https://ntietz.com/blog/using-an-engineering-notebook/

许多软件工程师没有采用作者认为非常有价值的做法:维护一份纸质工程笔记本。这并非像Jupyter那样的数字工具,而是对工作——目标、步骤和推理——进行即时、手写的记录,而不是事后记录。它模仿了研究中使用的详细实验室笔记本,旨在达到清晰的程度,以便另一个人(包括“未来的你”)能够重现该过程。 作者从2016年开始将这种方法用于客户工作,发现它对于组织和记忆至关重要。手写有助于回忆,并在编码*之前*迫使深思熟虑,充当“思考工具”,并明确理解的内容——以及不理解的内容。 虽然它不用于回顾性审查或分享,但写作的*行为*是核心益处。虽然它不适合所有人,但作者鼓励尝试不同的格式和细节,认为这种做法值得尝试,以提高生产力并理解自己的工作流程。

最近的 Hacker News 讨论强调了保持传统工程笔记本的价值。用户 evakhoury 分享了一篇文章关于这种做法,引发了关于其益处的讨论。 Woodruffw 强调,*书写本身* 极大地帮助记忆,即使细节很少——回忆旧笔记本中的想法比从 Obsidian 等工具中检索更详细的数字笔记更容易。 另一位用户 albert_e 提到,他/她即使笔记不常被重新阅读,也会在工作和会议中使用实体笔记本,并观察到同事中很少有人使用笔记本。 这场讨论强调了手写、记忆形成和保持上下文之间令人惊讶的强大联系,表明这是一种简单而有效的方法,适用于工程师及其他领域。
相关文章

原文

One of my core software engineering practices is writing, by hand, in a physical notebook. It's one of the most important things I do to remain productive and effective. Maybe the single most important. And it's a practice that I see very few others using!

When I polled my Mastodon followers, 25% of them said they use an engineering notebook, 40% said they don't, and 34% didn't know what one is! In two other programming communities I'm in, there were really similar results. This practice is really not very widespread, and since a lot of people aren't familiar with it, it's not only a matter of it working for some people but not others. (Though that's certainly a factor!)

First off, though, what am I talking about? I'm not talking about a specific kind of paper notebook. And I'm not talking about Jupyter notebooks. I'm talking about a practice of recording notes as you work on things, documenting what you're doing and why. This has long been a practice for researchers, keeping lab notebooks.

There are a lot of different practices, but there are some common characteristics between them:

  • They're very detailed. Each thing you're working on is recorded. Your hypothesis or goal is recorded. It's detailed enough that someone else could come along and replicate the steps.
  • They are dated. Each entry is provided with a date, so you can trace back when things happened.
  • They're done in real-time. Rather than recording information after a project is finished, notes are written as it progresses.
  • They create permanent records. Notes are written without erasing old notes, going forward in an append-only fashion. No pages are removed or modified.
  • They're the original record. This is where things get recorded first, instead of being copied into from other sources.

The level of detail is a particularly crucial bit, because, for your notes to be useful to yourself later? They have to be useful to someone else, too. Future you is someone else: you won't remember everything. So you have to assume you'll forget much of it.

I started using an engineering notebook when I started doing consulting work in 2016. With multiple clients at once, my organization was critical to projects succeeding. And it's continued to prove useful, across both corporate jobs and more client work, in the decade since. I use it because it helps me remember things, and it helps me think clearly.

My notebook is an incredible memory aid, in two ways. The first way is the obvious one: I can read back and see what I was working on, whether recovering from a momentary distraction or coming back from a long weekend. The second way is that writing by hand is the most effective way I've found to commit anything to memory. I think studies bear this out as a general thing among humans, that physically writing (and also walking or moving around), helps with thinking and memory, but it's certainly not true for everyone. It's probably worth a short, anyway, if you can try it.

It's also a very good tool for thought. I write things down as I go, to work them out. Rather than writing down the code changes after I make them, I usually write them in the notebook before I write the code in my editor (or I intend to, anyway). This forces me to think it through before I start mashing my keyboard. It also lets me leverage that benefit of physically writing, which helps me gain clarity about what I'm doing and about what I don't know yet. There's something about writing by hand that is often magical, and I think a lot of us have experienced it before, like when we use a whiteboard to solve problems.

I don't really use my notes for reading back later on. My notebooks haven't been helpful for me in that way, beyond checking what I did the previous day or so for standup meetings.

And I don't show them to anyone else, ever. They're entirely for my work. The writing is the work, in a lot of ways, since it's the thinking.

Maybe! I can't answer that for you. If you've tried using one, you can answer it and I'm curious what your experience has been.

But if you haven't tried using one, I think it's definitely worth a shot. At best, you gain a new practice that's helpful. At worst, you learn that it doesn't work for you, and learning more about how you work is usually a good thing.

And if you do use one, try changing it up! Experiment with the format and the medium. Experiment with the level of detail. Then share what you learn with everyone else, so we can get ideas from your experiments, too!


If you're looking for help on a software project, please consider working with me!

联系我们 contact @ memedata.com