TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:RE: How does your team track document requests? From:"Margaret Cekis" <Margaret -dot- Cekis -at- comcast -dot- net> To:"'Robert Powers'" <robp59 -at- gmail -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 23 Jan 2013 14:49:55 -0500
Robert Powers asked, " How does your team track document requests? I've used
various methods over the years: spreadsheets, to do lists, etc. We're
considering using Bugzilla (bug-tracking software) now since the software
engineers at my company are very familiar with it. We hope this would allow
for more integration with the software development process."
_________________________________________
My experience has been that some companies didn't have a formal process at
all, while others that had a very formal structure had a specific doc
request form. Where documentation has used the Development CMS, errors and
update requests were tracked in the bug-reporting system. I think using the
bug system is fine for tracking changes after a document is drafted and in
review, but I prefer a formal form up front.
Defining a new document for a new product requires a lot of information
about audience, purpose, and scope that may not have appropriate fields in a
bug report. If you're using only the bug tracking system, you may have to
see about adding a form for new documents that provides the supplemental
information, such as audience description (end users vs support staff or
developers, installers, etc.,) ; name(s) of project manager(s) for product
and documentation, assigned SMEs and writer(s), estimated release date of
product and documentation, etc.
Margaret Cekis, Johns Creek GA
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
See what's new in Doc-To-Help 2012 in a free webcast:
Read all about them: http://bit.ly/C1-webcast
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-leave -at- lists -dot- techwr-l -dot- com