Re: Tracking Software Defects That Affect Documentation

Subject: Re: Tracking Software Defects That Affect Documentation
From: "Bill Swallow" <techcommdood -at- gmail -dot- com>
To: "Roger Bell" <RBell -at- vcgsoftware -dot- com>
Date: Tue, 28 Aug 2007 10:12:22 -0400

Writers should have access to the bug base and should be tracking
every active issue tied to the release. IMHO, the writer is the only
person who can truly determine the documentation impact of a bug fix.
If others are "flagging" issues as needing docs, they often don't
consider or have the knowledge to determine the validity and size of
the impact on documentation. In that scenario, you'll likely have just
about every bug flagged, and the writer will need to wade through them
anyway. Best to remove what overhead you can from the process by
giving the writers full access to the bug base and training them to
check on it daily for new active issues as well as updated or fixed
issues, this way the initial scope of the docs impact can be known
even before the fix is implemented in the product.

On 8/28/07, Roger Bell <RBell -at- vcgsoftware -dot- com> wrote:
> Does anyone have a suggestion as to how best to use TeamTrack to
> determine what software defect fixes and design changes affect
> documentation? I'm sure some of you must have wonderful ideas and horror
> stories.
> Our developers and BAs may or may not know what affects our
> documentation when they enter or work on an issue in TeamTrack,
> therefore we have practically ruled out having an "Affects
> Documentation?". However, TeamTrack can be customized in many ways. What
> works for you?

Bill Swallow
HATT List Owner
WWP-Users List Owner
Senior Member STC, TechValley Chapter
STC Single-Sourcing SIG Manager
avid homebrewer and proud beer snob
"I see your OOO message and raise you a clue."

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.


Tracking Software Defects That Affect Documentation: From: Roger Bell

Previous by Author: Re: Great Technical Manuals from Canon!
Next by Author: Re: Quote of the Day
Previous by Thread: Tracking Software Defects That Affect Documentation
Next by Thread: RE: Tracking Software Defects That Affect Documentation

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

Sponsored Ads