Chapter 11. Reporting Bugs

During the iterative quality assurance testing process, bugs in either the new English version of a document or inconsistencies between the user interface (UI) and the documentation of the UI may become apparent. These bugs, such as broken cross references and glossary items that do not launch definitions, should be fixed in the localized version by the vendor. Vendors are encouraged to report bugs they find and can do so via e-mail.

In order for you to file bugs using e-mail, your login name and domain need to be registered to PV or BugWorks. This should be done by Silicon Graphics.

Addressing the E-mail

Address the e-mail to [email protected].

The following items are automatically generated by the bugs database:

  • Incident #

  • Submitter (this is parsed from sender of the e-mail)

  • Opened Date

  • Submitter Domain

Subject Field

The Subject field of the e-mail should be a brief summary of the bug and have the format

BUG short description of error

Message Contents

In order for the bug information to map to the fields of a bug report, type the following field names as shown and append each with an appropriate entry:

Priority Guidelines

  1. Severe error.

  2. Major loss of functionality.

  3. Miner loss of functionality.

  4. Nuisance error.


The CClist field should include the addresses for the localization manager, production editor, and any others who may be involved in the project. In order for you to receive a copy of the bug report, you should include you e-mail address, such as [email protected].

Description Guidelines

The Description should be detailed and provide enough information for a writer to locate the bug. The following elements should be included:

  1. Book title and part number.

  2. Chapter.

  3. Heading title.

  4. Detailed location of bug.

For example:

Desktop User's Guide, 007-1342-130
Chapter 6
Finding Large Files
Last paragraph is missing a cross-book link to the “Personal System Admimistration Guide”.