Three Parts to Every Dev Project

I think there are three main components to every coding project.... application, logging, and reporting.

Of course you have to have the application code, but why do we often leave off the other two?  It seems that even the smallest of projects require some level of logging/reporting, yet we often leave these off.  

Not having some basic logging features will result in poor debugging later because you can't trace a problem.  You don't have to log every little thing, but just enough to help locate a problem should something come up.

Reporting... eventually, someone will ask "how many times did... " or "what is the percentage of...".  Add a basic reporting mechanism to your application, so that you can, at least, answer the big questions.

For small applications, I have begun making a habit of using simple XML files to keep track of logging and reporting info.  It doesn't have to be complicated, in fact, the simpler the better.  A simple solution is likely to get used more!

Tags: