IBM Research

Center for Software Engineering

Software Engineering Research: Extensions to ODC

Topics

Center for Software Engineering Home

Orthogonal Defect Classification

Testing

Software Data Analysis

Publications

University Partnerships

Conferences & Workshops

Write Us


 

ODC Extensions V5.11

Historically, ODC for Design and Code is the scheme that has been used the most in software projects and research articles. However, it is clear that development of design or code is different from the common problems in user documentation, Graphic User Interface, Build/Packaging, and National Language Support. To meet these needs, we have evolved some ODC attributes for these areas also.

  • The scheme for User Documentation has its own unique Triggers since it is different from the development and testing of the Design or Code.
  • Finding GUI defects is typically a separate activity, while the fixes are still in the design or code.
  • However, the current schemes for Build and National Language Support (NLS) assume that defects are being found by the normal testing process for Design and Code (using the same triggers and impacts) while the nature of the fix may be related to the Build process or the NLS specifics.

 

 

Software Area of Interest

Information Development (User Documentation

Graphic User Interface

Build/Package

National Language Support

IBMIBM ResearchComputer ScienceCenter for Software EngineeringLegalPrivacySearch IBM

Last Edited on February 1, 2002

 

 

 

Information (User Documentation) Development

Opener Section

(These attributes are usually available when the defect is opened.)

Closer Section

(These attributes are usually available when the defect is fixed.)

Defect Removal Activities
Triggers
Impact
Target
Defect Type
Qualifer
Age
Source
Content Type
ID Review
  1. Accuracy
  2. Clarity
  3. Completeness
  4. Consistency
  5. Organization
  6. Retrievability
  7. Style
  8. Task Orientation
  9. Graphic Design/Aesthetics
The same as that for

Design and Code

Information Development
  1. Editorial
  2. Technical
  3. Navigational
The same as for Design/Code
1.Reference-Information
2.Tasks
3.Examples
4.Presentation
5.Concepts

 

Graphic User Interface (GUI)

This only addresses the visual aspects of GUI and not the underlying functionality.

Opener Section

(These attributes are usually available when the defect is opened.)

Closer Section

(These attributes are usually available when the defect is fixed.)

Defect Removal Activities
Triggers
Impact
Target
Defect Type
Qualifer
Age
Source
GUI Review
  1. Design Conformance
  2. Widget/Icon Appearance
  3. Screen Text/Characters
  4. Input Devices
  5. Navigation
  6. Widget/GUI Behavior

The same as that for

Design and Code

Design/Code
The same as for Design/Code

 

Build / Package / Merge

This only addresses defects found in the Build and Packaging process only.

Opener Section

(These attributes are usually available when the defect is opened.)

Closer Section

(These attributes are usually available when the defect is fixed.)

Defect Removal Activities
Triggers
Impact
Target
Defect Type
Qualifer
Age
Source
Design Rev, Code Inspection, Unit test, Function Test, System Test.

The same as that for

Design and Code

Build/Package
The same as for Design/Code

 

National Language Support

This only addresses the aspects related to the translation of the software to the user's natural language (German, Japanese, etc.) and does not consider underlying functionality.

Opener Section

(These attributes are usually available when the defect is opened.)

Closer Section

(These attributes are usually available when the defect is fixed.)

Defect Removal Activities
Triggers
Impact
Target
Defect Type
Qualifer
Age
Source
Design Rev, Code Inspection, Unit test, Function Test, System Test.

The same as that for

Design and Code

National Language Support
The same as for Design/Code

 


 

Information Development Triggers

Information Development
Development and Inspection of external user documentation, help text, user's guide, screen information

Examples:
1) The error message was spelled incorrectly.
2) The help text listed 3 steps to add a record but there were 4.


Accuracy:
The information does not describe the product correctly; there are factual errors.

Clarity:
The information is confusing or difficult to understand.

Completeness:
Necessary information is missing.

Consistency:
The information is not displayed in a consistent manner. There are different explanations, spellings, wording, etc... for the same piece of information.

Organization:
The relationship between parts or between a part and the whole is not conveyed.

Retrievability:
The information is difficult to find.

Style:
The manner of expression is inappropriate or difficult to understand.

Task Orientation:
The presentation of why and how to perform a task is inappropriate.

Graphic Design/Aesthetics:
The appearance and layout of the information is inappropriate.


Defect Target

Represents the high level identity of the entity that was fixed.

Build/Package/Merge
Problems encountered during the driver build process, in library systems, or with management of change or version control.

Examples include:
1) Part not defined to build process. Mapping macros required to assemble application programs missing from a public library.
2) Module compiled using a back-level version of a source code part.

Information Development
The problem is with the written description contained in user guides, installation manuals, on-line help, user messages.

Examples include:
1) An installation problem is experienced because there was no user documentation of the data sets to be allocated before the installation was attempted.


National Language Support
Problems encountered in the implementation of the product functions in languages other than English.

Examples include:
1) Message contains garbage for French only
2) Cannot print German specific characters

 


 

DEFECT TYPE


Represents the actual correction that was made.

 

Defect Type for Target= Information Development


Editorial
Defects relates to grammar, spelling, punctuation, organization, etc... necessary to build the information describing a product.

Examples:
1) The help text that is displayed has a spelling error.

Technical
Defects related to the description of a product and its interfaces.

Examples:
1) The Installation Guide shows an incorrect wiring diagram for connecting the modem to a computer.

Navigational
Defects that prevent users from finding needed information about a product including errors in mechanisms used to connect information (i.e. hyperlinks, indices, tables of contents, cross references, book shelves, etc...).

1) When the user clicked on a hyperlink on the web, it got the message "Netscape is Unable to Locate the Server..."

 

Defect Type for Target=Build/Package


Process Conformance
Problems with the specified procedure to be followed for the build.

Code Integration
Code from one area caused a build/execution break in another area. A dependency was missed. Also used with an incorrect merge of two source files.

Maintenance Application Dependencies
Incorrect or incomplete pre-requisite, co-requisite, or sequencing of dependencies is captured.

Shipped Files
Problems with the shipped files of a file set, such as dual ownership, system errors (bad size, checksums), etc...

Packaging Scripts
Problems with the scripts used by the file set during install, de-install, upgrade, migration, etc...

Feature Install /Upgrade Dependencies
Problems with the set of files required for installation or problems with requirements, such as missing, incorrectly specified, inappropriate, etc...

Media
Problems with the package used to distribute the software. This would include problems with a CD-ROM, tape drive, etc...

 


Defect Type for Target=National Language Support

Translation
The translation was incorrectly done or was missing altogether.

Character Handling
The inability of the program to correctly handle characters associated with another language. Examples: Command/menu input does not accept multi-byte characters, array parsing assumes single byte characters only, or program strips 8th bit when processing data.

User Interface
The inability of the user interface to function or display correctly in another language. Examples: Motif application buttons expand entire window in Chinese, calendar icon does not display localized data, or web interface does not display Russian characters correctly (font problem, not character handling).

Language Expectation
When a command or program is checking for a specific input or output as an English or C locale would provide it.

Enablement
When the product was not designed or incorrectly designed to enable National Language Support.



Information Development Content Type

This captures the nature of the information content that had the defect.

Reference Information
Defect contained in detailed descriptive information such as definitions, dictionary entries, glossary items, parameter
explanations, etc...

Tasks:
Defect contained in guidance information that describes the user tasks of the underlying product.

Examples:
Defect contained in special descriptive information of a detailed nature showing specific applications of the described product.

Presentation:
Defect contained in graphical and other elements used to present the information, such as music, fonts, colors, layout, packaging, tables, etc...

Concepts
Defect contained in high level overview and conceptual information describing important characteristics of the product like function or performance.


GUI Review Triggers


Design Conformance:
Defects found while reviewing GUI design documents.

Widget/Icon Appearance:
Defects found while reviewing widget and icon appearance (wrong color, too big, etc...).

Screen Text/Characters:
Defects found while reviewing text or characters, for example, button mislabeled.

Input Devices:
Includes defects found while testing various input methods including mouse, keyboard, touch screen.

Navigation:
Defects found while attempting to navigate within or between windows, menus, or components.

Widget/GUI Behavior:
Defects found while testing the expected behavior of widgets and icons (widget doesn't get focus, multiple list items end up with selection emphasis, help button doesn't work).