Configuration Management
Issue Tracking
Issue Reports
|
Issue Type
Some tracking systems, (such as TeamTrack) include an "Issue Type" field with the following
values pre-populated.
- Bug Report
- Enhancement Request
- Change Request
- Task
- Problem Report
Almost every issue logged could easily fall into at least two of the
above values for Issue Type. Therefore, I strongly recommend not using this field unless you have a common definition and set of field values that have greater meaning and less ambiguity.
Proposed Definition:
- Issue Type determines the State-Transition
pathway that an issue may follow during its lifecycle.
- It indicates the highest level classification of an issue.
- Issue type may indirectly infer the general area of responsibility within the
organization, but not which person, is responsible for the issue (see Functional Area).
|
One key aspect of the 'Issue Type' field is that the State-Transition
table can branch differently based on the issue type. The suggested list
of States and the State
Transition Diagram pertain most strongly to what would be software engineering
issues, and may or may not apply for cases more pertinent to document management.
Along those lines, I suggest using values such as these for Issue Type, where the value focuses more on the group, department, or workflow that will be managing the issue based on its type.
| Issue Type |
Notes |
DOC
Documentation |
- Indicates that there is something wrong or missing with the
documentation.
- Documentation issues refer to something wrong with text somewhere: MRD's, PRD's,
Design docs, Help Files, etc.
- DOC issues are typically addressed by
copy-writers and/or marketing.
- Do not confuse this with a known bug which is being covered in release notes (which would still remain an open issue).
|
CE
Configuration Error |
- Indicates the issue is not with the product, but with how it
was deployed, installed, or configured.
- This is more common with server-side components or products that lack a fully featured install application (such as an MSI).
- These issues are typically addressed by
Operations (internal) or by support-staff working with the customer.
|
FR
Feature Request |
- Also known as Design Change Request (DCR).
- Refers to something which would have to be changed in the design doc in order for the
change to be valid (update design and then update the product).
- These issues are typically reviewed and/or
approved by Project Managers before acting upon them.
|
CD
Code Defect |
- This is your typical "bug" -- something is wrong, or does not behave
as expected.
- It is expected that most of the issues will be of this type.
- These issues are typically addressed by
developers.
|
ART
Problem w/Artwork or graphics |
- Images that don't display properly, place-holders, animation problems, incorrect screen shots.
- These issues are typically addressed by
the artists or 3rd parties supplying image resources.
|
PKG
Packaging / Installation |
- The issue is not with the product per-se.
- Anything pertaining to the "user install experience" is an "Install
/ Packaging" issue.
- These issues are typically addressed by
Marketing, Configuration Management, or by 3rd party developers.
|
Contact Primary Goals for a detailed review of your issue tracking system, or for consultative assistance to ensure that you have a smooth deployment of your CM system.
|
