About Taking Notes and a Good Tool for Visuals
The biggest tip IT tip I believe I gave anyone is “take your own notes”. Never, under no circumstances, let anyone - not your coworkers, not your boss, not your mom - no one, touch your notes. Needless to say, org-mode tripled the importance of this tip, and my notes have long grown to wikis: one for work, one for personal matters.
Sharing knowledge with the team is one thing. At work, we have a SharePoint wiki officially, and a bunch of other unofficial documents laying about (I wrote a post explaining the problems of this system before). When I write a knowledge base article for our team or our users, what they see is usually a polished copy of the latest version of my own notes.
I say the latest version because my notes are dynamic and built to change. My wiki is written in org-mode which is the perfect dynamic environment for this. What I write contains personal comments and examples that won’t always make sense to others, with references to additional projects from the past that others are not familiar with. My workflows, though often used for the entire team later, are firstly written to make sense to me only.
When you count on someone else’s notes, you lose half of the information just by not writing the information down yourself. When you write something and let others manipulate the text, even if they are more knowledgeable (especially if they are more knowledgeable), the information as you retain it is disconnected from your own thinking process. When someone explains something to you, you should be able to write it down in a way that makes sense to you. If you can’t, you probably didn’t get the explanation and should ask more questions built to close the gaps in your understanding as you see it in your notes1.
In my opinion, the lack of taking notes is one of the biggest issues at work and meetings, where usually we end up cutting into each others' sentences just to get our ideas across. You can only listen and write down notes from one person at a time.
Let’s not confuse agreeing on a procedure vs understanding it. These are too different things. Accepting instructions and following them does not necessitate understanding the process behind the instructions. But, if we take the time to understand the process, we can improvise and use the knowledge we have (hopefully reinforced by good notes) to problem-solve in real-time.
The reason I bring all of this up is because someone on Reddit asked for the best tool in Emacs for non-creative writing and writing out procedures. At this point, you already what tool I recommended.
One thing however that is often present in good notes org-mode cannot do: visual aids. I’m sure there are packages out there to help with this, probably most familiar these days is org-roam. To me, org-mode is a textual tool (as is Emacs), and diagrams are visual. One to be used with a keyboard, the other with a mouse.
The tool I’ve been using to draw diagrams for years has been draw.io (now called diagrams.net). I got to know it as a browser-based tool back when I had a Chromebook, and its simplicity and flexibility kept me from going anywhere else. It also exists as a desktop application from git for Windows, macOS, and Linux. draw.io makes it easy to place basic shapes from flow charts, like arrows and different shapes, resize them, rotate, and snap to each other on a grid background. It comes with plenty of options to optimize the colors, the thickness of lines, text inside shapes, and even uploaded images. When you’re done, there are export options to Google Drive, GitHub, local XML or PNG files, and even PDF export.
To give you an idea, here are two sample images, both created with draw.io. The first one is a pretty infochart, the other is a simple workflow.