RE: Error management in documentation

Subject: RE: Error management in documentation
From: Jim Shaeffer <jims -at- spsi -dot- com>
To: Kevin McLauchlan <KMcLauchlan -at- chrysalis-its -dot- com>, TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 19 Oct 1999 11:00:35 -0400

Kevin McLauchlan wrote:
The developers record *everything* in their database, so there is no
searchable/filterable distinction between formal "bugs" in released
software, and glitches, suggestions, explorations, afterthoughts, etc. that
go along with the in-house development process.
This is an organizational problem, not a documentation one. The tool we use
is set up so that, before an issue is added to the database, it must be
categorized as a Problem, a Request for a change or a Requirement to be
analyzed for new releases or new products. It must also have a Severity
level. Severity levels drive the allocation of resources. Every issue must
also be identified with its Product and the module within the product.
All of the above should be configurable in any good issues tracking program.

In addition, our process requires that new issues must be reviewed by an
acceptance board before the responsible parties work on them. This board
includes developers, management, a representative of the testing department
and (on some products) the documentation guy.
That may sound like a lot of bureaucratic process, but we learned the hard
way that it saves a lot of time and grief.

Jim Shaeffer
Jims -at- spsi -dot- com

Previous by Author: RE: In-house printing: another note in favor!
Next by Author: RE: TW leading GUI design team
Previous by Thread: Re: Error management in documentation
Next by Thread: RE: Error management in documentation

What this post helpful? Share it with friends and colleagues:

Sponsored Ads