3 ms·
The best is the enemy of good here. When I manage engineers, I insist on people having the old-fashion pen and paper notebooks: not scratch paper; not pads; no
by CharlesMerriam2 7y ago
The best is the enemy of good here.
When I manage engineers, I insist on people having the old-fashion pen and paper notebooks: not scratch paper; not pads; not post-it notes. Simple 5 by 7 grids. During my weekly one-on-ones, I encourage people to make one or two positive changes:
* jot down any odd term they run across so they can google 'strangeNewTerm slides' later and batch through them all
* write a quick note on any error taking over twenty minutes
* go back and read their notebook here and there
People do use the notebooks, do record the information, do get sick of writing and do start reaching out for other ways to record information. I allow people to use Wikis, markup files, documents, or a mishmash: people are more likely to work on their own idea. I do insist that documentation be in source control and have 'section last updated' dates. Eventually, I encourage someone to maintain a master index of where non-code documentation is found.
The hard part is getting people not to document too much. Every document has a maintenance load, much like every line of code. It is far better to have an up-to-date hint like "TPS reports need cover pages per YoyoDyne contract, 3/2004" than volumes of out-of-date procedures, one of which mentions the YoyoDyne contract on page 37.
One totally different tact: new developers get assigned to the source code control review. That is, they look at the new commits; run the new code, update the project/company specific dictionary with any new terms; give the tests a careful reading and add to them; and write down any question. New developers quickly become familiar with the code base that is most likely to change.
- jupp0r 7y agoSomewhat off topic: Not sure who you are managing, but for me being told how to take notes would be a huge red flag. Give your people some autonomy.
- CharlesMerriam2 7y agoEveryone gets micromanaged for a moment until they move on. On your first day, someone micromanages showing you where the restrooms are and how the breakroom works. Then they never do it a second time. In practice, you can revisit even a small point like taking notes as often as the other person finds experimenting with your advice makes her a better engineer.