Re: Bug tracking and documentation

Subject: Re: Bug tracking and documentation
From: That Darned Writer <j_grey -at- writeangles -dot- com>
To: Technical Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 13 May 2009 09:08:49 -0700

Julie Stickler wrote:

> Where the system breaks down is when someone enters issues like “Guide
> X needs to be completely rewritten.” Or someone enters pages of
> documentation reviews/comments as an “issue.” Because our process
> requires QA to close issues, and our QA team really has no idea how to
> judge if this type of issue is “fixed.” I end up force closing a lot
> of these, or listing them as “not a bug.”

We use the same bug tracking system for docs as for the software. If
someone logged a bug against docs with "doc needs to be rewritten" I
would reassign it to them or reject it with "needs more info."

If your process requires QA to close issues, they should be able to
verify that review comments were included or rejected. If they were
rejected, do you comment that in the bug? Doesn't QA review and test the
docs as part of the QA process?

Have you provided your team with guidelines on creating documentation bugs?

joanne grey j_grey -at- writeangles -dot- com
principal writer

They deem him their worst enemy who tells them the truth.


ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals.

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control!

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.

Please move off-topic discussions to the Chat list, at:


Bug tracking and documentation: From: Julie Stickler

Previous by Author: TECHWR-L Premium Jobs, Events, and Announcements
Next by Author: Re: Bug tracking and documentation
Previous by Thread: RE: Bug tracking and documentation
Next by Thread: Re: Bug tracking and documentation

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

Sponsored Ads