Writing documentation is not something I like to do. People always like to list the reasons why you should document, and today, I was reminded of why documentation is important, and was thankful that I had put forth the effort to write the documentation.
I am working on re-writing a piece of static code that handles the rules for processing data, into a more dynamic approach uses the WF rules engine. I had started this several months ago, and according to my notes, worked on this last, July 12. Finally, after 2 months, I have been able to get back to work on the rules, and thanks to the documentation I had been writing (in the form of notes), I was able to get back up to speed fairly quickly.
I think the key in this instance, was to write down notes as I came thought of them. Usually I hate writing stuff down when I’m in the early stages, because it always changes. However, this time writing notes down as I went has helped out allot, and so far, has not had to be updated as much.
So remember, the next you are debating about writing something down, it may not just be for the benefit of the next developer who comes along, it may be for your own benefit.