2004-03-03 Keep A On The Job Log

Keep A On The Job Log

I've found keeping an on the job log to be very useful. The log usually includes my account of the various events that go on in a project, things I learned while on the job (could be perl tips, scripting, ideas about software development politics). I've been complemented on one large project where my log gave a lone, unique account of the technical challenges of a project from the developer's point of view.

A lot of my log entries are written in pattern form. This is a format that places notes in Problem, Analysis, Solution sections. The problem is a one line statement of the problem. Analysis is the thought process to understanding and addressing the problem. Solution is a short description of the final solution. I generally search from these patterns. When I come across a problem I know I solved before, I can find what my thinking was behind the solution. Then, I apply the same thinking towards the similar problem.

I rely on my project log as my memory on the events and lessons learned on my projects.