DEV Community

Adam Davis
Adam Davis

Posted on

How do you take notes while you code?

Do you like to take notes when you're writing code?

Do you organize them in some way, or do you only keep notes about your current tasks?

What pieces of information do you think are helpful to keep track of?

Latest comments (56)

Collapse
 
mikeyolang profile image
Michael Otieno Olang

I always use Markdown to take notes and a piece of paper to sketch the project

Collapse
 
alexisfinn profile image
AlexisFinn

Don't usually take notes just to myself.
1- If it concerns the functionality it should be add to the ticket
2- If it's a todo-list of things I need to do on my current ticket add it to the commit message
3- If it's something technical concerning the code it should be documented in the source-code
4- If it concerns architecture, how to install/run, add it to the repository README

Collapse
 
waigani profile image
Jesse Meek

I use CodeLingo Notebooks for code notes.

It's like Notion for devs. It's a web doc with markdown formatting, but you can insert "blocks" that integrate with editors and VCS hosts (e.g. github): here's a video demo:

I mainly use code snippets that you can click on to locate the code in your editor again. So you can literally navigate the codebase with your notes.

For example, if I'm touching several bits of code across the repo, I go back to the note to remind myself what the next step was, click on the snippet and it loads the exact bit of code up for me in my editor.

It's got a bunch of other features on top, chatting with your team on a snippet, applying a patch etc.

Full disclosure, CodeLingo Notebooks is my own project so I'm obviously biased but I can honestly say I can't imagine coding without it now. Super keen to hear people's thoughts.

Happy Coding 😊

Collapse
 
johndoe0999 profile image
CEO of ACME inc.

I've got many TODO comments and IDEs highlightt them for me. Eric6 has this nice littlle TODO list for all loaded files.

Collapse
 
muhyilmaz profile image
MUHAMMED YILMAZ

Trello.

Collapse
 
utkarsh736 profile image
Utkarsh736 • Edited

I don't take notes anymore as it wasn't helping me but rather taking up a lot of my time.
I just try to practice the concept in code and look to alter it to grasp a better understanding.
If there is a point that I always seem to forget or find myself googling it repeatedly then I note that point down just anywhere(don't usually read it again) but just writing it makes me remember it.

Also, if it is a tutorial type project then I add simple comments for me to understand later.

Collapse
 
frisodenijs profile image
Friso Denijs

It depends on what the notes are for:

  • If they relate directly to the code and are useful to the team, then I add it as comments
  • If they are to remember to do something that's out of scope at the moment, then I add them as item(s) to the backlog
  • If they are lessons learned, then I add them to my lessons learned repo on GitHub
  • If they are to visualize an idea for me, then I sketch it on paper
Collapse
 
tmchuynh profile image
Tina Huynh

I love using Pocket to keep tabs of everything I think I will go back to, resources that could be useful overtime, etc. Other than that, I use my bullet journal to write down pieces of information I may learn each day and index them as needed. If needed and specific to the project I am working on, I'll add comments to the document for me to return to the next day or following week.

Collapse
 
brewinstallbuzzwords profile image
Adam Davis

I've been using Pocket intermittently for years. I always seem to forget it exists a couple months after I start using it, then try it again a year later.

Do you have any spreads in your bujo that you find particularly helpful for this sort of thing? Or does most of it end up in your daily logs?

Collapse
 
skydevht profile image
Holy-Elie Scaïde

Right now, I'm adding Craft to my workflow. I can keep a lot of information in my head, but that tires me. So I jot them down. That have also reduce my development time. It's mostly things that I would talk to someone else if I was working with a collaborator. I've also use goodnotes as a whiteboard when I need to break down a tough problem. If I'm doing research, I dump everything in apple notes to organize and distill later.

 
610yesnolovely profile image
Harvey Thompson

Before starting with org-mode, I wasn't sure if it was worth learning. Oh my, how wrong I was.