Tuesday, 7 December 2010

Logging vs Documentation vs Tutorial

I'm new to this logging business. So I'm probably not quite clear on what I want from it.

On the one hand, I want some documentation for the class heirarchies I'm busy evolving for Clonemaster. On the other, I want to keep a log of my progress. On the third hand (counts hands; looks puzzled) I want people to be able to understand what I'm banging on about so they can make use of this stuff themselves.

I'm not sure all these things are 100% compatible though. There's a lot of stuff to document, even more if I have to explain everything from the ground up. And taking the time to do that cuts into dev time, or means that my development efforts lag behind my logging - which defeats the object of the exercise, Well, one of them, anyway.

I'm rambling on like this because I'm annoyed with myself for publishing the UML diagram without explaining the classes. Next post ...

No comments: