Keep notes close to code
I keep notes in the same directory as code. This makes it easy to reach. Here is a sample for notes taken when working on Wireshark:
The newest notes are at the top of the file. This results in less scrolling to see recent notes or add new notes.
Each logical section is separated with the line containing --.
I use a global .gitignore_global to ignore this file from git. The file is named KEVINALBS-README.md.
Keep TODO lists and Open Questions on paper
I find hand writing TODO lists helpful. It permits checking off a TODO list item.
I write Open Questions on paper in this format:
The "A:" with empty space means it is an open question. I check off the "Q:" when the question is answered. I think I am more likely to remember Open Questions when I hand write them. That cues me to look for answers if I see them. Hand writing is a larger barrier than typing. I am more likely to make a shorter and clearer question when hand writing.
Draft external communication
I draft descriptions for Pull Requests in my text editor. This permits writing them as I work on code. Example:
I draft descriptions for Jira tickets in my text editor. Jira does not have a "save draft" feature. And often I may not have all information, or time / energy to write a full ticket in one sitting.
Top comments (1)
Hey, the title sounded very familiar to me 👍. I always keep notes on any work I do. Typically, when I start to work on a job or a project or a post, etc., I keep notes in a text file using a typical text editor. It has details about starting date, research notes and links, design details, code samples, etc. Its also like a scratch pad for that project. Often for larger work I end up with multiple notes files - one each for each functionality. These get updated as I work and as needed. Later all these info transform into actual work.