Channels ▼
RSS

Design

Making Issue Tracking Drive the Development Process


Integrate with Other Systems

Choosing a system with a flexible API makes it easy to integrate with other systems such as source control or the build system. Integrating systems increases transparency across the engineering process. For example, the tool should integrate with other code repositories, as well as the continuous integration (CI) server, and the project wiki to track an issue's progress into working software. Engineers can check-in new code to source control, and the issue tracker will pick-up on that update. The CI server can then update the issue tracker noting that the referenced issue has been built into working software. When related systems automate manual processes, everyone wins.

Categorize to Optimize

As an industry we've grown beyond bug tracking. It's now all about work management. We don't just fix bugs, we innovate through software. Some of that is writing new features. Other times, it's rearchitecting existing code. And yes, of course, we still fix defects. When we commit all of our work to our tools, we can see the entirety of what we do.

Modern work management tools can categorize issues by sprint, release, component, or theme, to name a few categories. In practice, it's much easier to implement related tickets at the same time. When issues are organized by component, it's easier to see all of the work that needs to be done in a particular area. The team can then plan when that work needs to be performed over the next several iterations, thus optimizing time spent in a certain area. Issues can also be categorized by priority. It's always helpful in retrospect to see which high-priority issues had to be dealt with in an unexpected way during an iteration.

Remain Lean

One of the most important things to keep your issue tracker healthy is regular triage of incoming issues and grooming the backlog. Software is dynamic. Priorities change. Regular triage keeps the team in tune with the current state of the product. The backlog is the list of work that outlines the future direction of the product in priority order. When new feature requests or bugs come in, they need to be prioritized against all of the existing work. Keeping the backlog current gives the engineering team confidence that they are working on the highest priority items.

As a QA engineer early in my career, I hated closing bugs that were not fixed. A user reported i, so it must be relevant, right? At some level, yes; but feedback has a shelf life. As more and more issues get logged in the system, it becomes harder to focus on the issues that matter. Bugs that were filed five years ago are, generally speaking, less relevant than ones filed last week.

If an issue has no path to closure in the foreseeable future, close it. Closed issues are not lost. When closing an issue, always include a resolution so you can search it later. At a minimum, resolutions should include: fixed, will not fix, cannot reproduce, and obsolete. Obsolete issues those that are no longer relevant to the direction of the program. Product managers can then search closed issues in the same way that they search open ones. In the closed case, issues that got marked will not fix and obsolete represent real work that was deferred.

Going Forward

For years, companies have viewed the defect tracker as a tool apart. During the last decade, it’s become evident that the addition of feature requests has converted the tracker into a planning tool for team sprints and individual work. Thus, it is the central product for capturing project status accurately.

The guidelines I list here should help you move from a traditional siloed view of defect tracking to a broader view that enables team coordination, better planning, and improved delivery.


Dan Radigan is an Agile Evangelist at Atlassian, makers of JIRA. Prior to Atlassian, he was an engineering manager at Netflix.


Related Reading


More Insights






Currently we allow the following HTML tags in comments:

Single tags

These tags can be used alone and don't need an ending tag.

<br> Defines a single line break

<hr> Defines a horizontal line

Matching tags

These require an ending tag - e.g. <i>italic text</i>

<a> Defines an anchor

<b> Defines bold text

<big> Defines big text

<blockquote> Defines a long quotation

<caption> Defines a table caption

<cite> Defines a citation

<code> Defines computer code text

<em> Defines emphasized text

<fieldset> Defines a border around elements in a form

<h1> This is heading 1

<h2> This is heading 2

<h3> This is heading 3

<h4> This is heading 4

<h5> This is heading 5

<h6> This is heading 6

<i> Defines italic text

<p> Defines a paragraph

<pre> Defines preformatted text

<q> Defines a short quotation

<samp> Defines sample computer code text

<small> Defines small text

<span> Defines a section in a document

<s> Defines strikethrough text

<strike> Defines strikethrough text

<strong> Defines strong text

<sub> Defines subscripted text

<sup> Defines superscripted text

<u> Defines underlined text

Dr. Dobb's encourages readers to engage in spirited, healthy debate, including taking us to task. However, Dr. Dobb's moderates all comments posted to our site, and reserves the right to modify or remove any content that it determines to be derogatory, offensive, inflammatory, vulgar, irrelevant/off-topic, racist or obvious marketing or spam. Dr. Dobb's further reserves the right to disable the profile of any commenter participating in said activities.

 
Disqus Tips To upload an avatar photo, first complete your Disqus profile. | View the list of supported HTML tags you can use to style comments. | Please read our commenting policy.
 

Video