Re: GNATS documentation evaluation

Subject: Re: GNATS documentation evaluation
From: Megan Golding <mgolding -at- secureworks -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: 29 Oct 2001 17:32:39 -0500

[a bug tracking system such as GNATS]
> automatically keeps track of each request, and it is easy to
> get info on the status of the requested changes.
> Yet a very possible disadvantage in that a project coodinator
> could end up spending a lot of time handling many individual
> change requests (evaluating, assigning, etc) for many minor
> changes (rewording of sentence, word change, spelling
> change). In cases of minor changes, the time required for a
> quality assurance tester to report the change (indicate a
> clear change report title, write up description, indicate
> place in manual, etc) could easily take 2-3 times more
> effort and handling time than making the text corrections
> in a Word document and a technical writer keeping track of
> changes in a spreadsheet.

Automated change request and bug tracking systems are a Good Thing. The
extra time taken by tracking changes is more than made up for when you
point to the date and version of the document in which said change was
made. I've tracked document changes in Bugzilla for about a year now and
find it far easier on my memory than the yellow stickies I was using at
a previous job.

I love tracking documentation the same way as the code because it keeps
documentation issues in front of the QA Team's eyes. If I have
outstanding bugs, then the QA Manager will inquire about them rather
than releasing the code and causing me to rush around to complete
things.

I consider GNATS and their ilk to be signs of a more mature
development/documentation organization. They force you to formalize how
you handle your documentation process.

Meg


--

Megan Golding (mgolding -at- secureworks -dot- net)
SecureWorks, Inc.

Don't worry about the world coming to an end today.
It's already tomorrow in Australia.
-- Charles M. Schulz



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Announcing new options for IPCC 01, October 24-27 in Santa Fe,
New Mexico: attend the entire event or select a single day.
For details and online registration, visit http://ieeepcs.org/2001

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.


References:
GNATS documentation evaluation: From: Jeff Allen

Previous by Author: Re: PDFs on Unix
Next by Author: Re: GNATS documentation evaluation
Previous by Thread: GNATS documentation evaluation
Next by Thread: Re: GNATS documentation evaluation


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

Sponsored Ads


Sponsored Ads