RE: Tracking Documentation

Subject: RE: Tracking Documentation
From: "Andrew Dugas" <dugas -at- intalio -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 9 Oct 2002 12:01:11 -0700


I once worked in a dev environment in which TeamTrack was applied to
documentation in such a way as you describe.

For example, from the outset, you would enter a task ("Write Installation
Chapter") and set milestones (draft, revision, final). At each stage,
reviewers would enter documentation "issues" into TeamTrack and categorize
them as one of the following: error, out-of-date content (including
screenshots or other graphics), new info to be added, or enhancement
request.

The document in question was also specified and since each document had an
"owner", it was no great task to assign the doc issues after they'd been
logged. The owner was then responsible for taking care of the fix, reporting
its status as it changed, including the build in which the fixes would
appear.

Thus TeamTrack provided an automated and detail-rich task list for the
writers and the tech pubs manager. Also, the product manager could get an
overview of where documentation was in relationship to the rest of the
product development. If as a writer, you weren't sure what needed to be
done, don't worry, TeamTrack had a list of everything you needed to do! (Of
course, you helped create the schedule and tasks in the first place.)

So in addition to a marked up hard copy of "Installation Chapter" you would
have a TeamTrack task "Revise Installation Chapter" that listed errors and
so on.

I loved it and I miss it. In addition to doc tracking, it was a great
organizing tool. We use a similar bug DB type method in my current position,
but it doesn't have all the reporting features TeamTrack had.

HTH

Andy



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at http://www.ehelp.com/techwr-l

Buy ComponentOne Doc-To-Help 6.0, the most powerful SINGLE SOURCE HELP
AUTHORING TOOL for MS Word. SAVE $100 on the full version and $50 on the
upgrade. Offer ends 10/31/2002 (code: DTH102250).
http://www.componentone.com/d2hlist1002

---
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:
Tracking Documentation: From: Tara Bowman

Previous by Author: RE: taking too long
Next by Author: RE: senior writer promotion
Previous by Thread: Tracking Documentation
Next by Thread: RE: Tracking Documentation


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


Sponsored Ads