Why Log Your Issues

| Comments

When you’re working on a software project, what’s the most important deliverable? Why, the software! It’s your eventual product. Along the way, however, there will be some things you can do that will make it more likely you successfully ship great software. One of those is logging issues. Here’s why you might want to do it.

A github log

Just Log It

There are many tools. There are many strategies. The most important thing will be to just get your issues logged in a persistent system that everyone involved agrees upon.

The benefits will include:

  1. You’ll remember it - Software projects are complex. You’ll run into a lot of issues. You don’t want to keep them in your head.
  2. You’ll have a historical record - Projects can take a long time to finish. And often they aren’t done in contiguous calendar time.
  3. You’ll remember past mistakes
  4. Maybe it’s a bit of lemon juice on old wounds, but that’s better than reverting your software to do the same dumb things again. By examining your once-resolved issues, you can remember not to go down certain paths again.
  5. You’ll have a todo list - Today’s software projects move fast, and there’s a lot going on in the office. To help you remember, what you need to do and in what order, look to your issues list.
  6. You’ll have a clearer picture of your progress - You’ll know how much farther you have to go on your milestones. You’ll have a finite list of exactly what is left that needs to be solved.
  7. You’ll have an alert system - When things go South, and bugs pop up, you’ll have an immediate global notification system. That is, if the team is tuned into your issue tracker this way.
  8. You’ll invite others to help you - When it’s clear what needs to be done, people have a better-defined path to get started helping you out. He sees an issue that is close to his expertise or interest, assigns it to himself, and goes!

Some Effort

Of course this takes some effort. Try to track issues more readily and steadily, and see if you don’t feel some of these benefits for yourself. It’s an investment into your process that should add to your capability to ship great software.

Some Caveats

This benefits mostly have some major assumptions, like: people actually care; it’s a painless process to add issues, assign issues, and resolve issues; the issue tracker has good notifications – meaningingful and to the people that matter. Well, there are lots of ways to mess that up as well. But try it. Do what works for your team.

What have you found to help your team be most successful in issue tracking?