Re: Bug tracking and documentation

Subject: Re: Bug tracking and documentation
From: beelia <beelia -at- gmail -dot- com>
To: Julie Stickler <jstickler -at- gmail -dot- com>
Date: Wed, 13 May 2009 13:04:56 -0700

Julie

Most bug tracking systems (we are currently using Bugzilla) have options for
users that specify "Documentation". You might want to check yours for that
option, and ask your managers to get users to always select that option when
filing a doc bug.

When we used ClearQuest Attache, we had a handy little check box for
"Release Notes". Users had to be trained to use it, but once they got used
to it, I was able to run a query and see all of them at once, making short
work of preparing RNs.

Also, if you have a QA Engineer managing the system, he or she might also be
able to configure the software to provide special options that are useful to
you.

HTH.

Bee

On Wed, May 13, 2009 at 10:17 AM, Julie Stickler <jstickler -at- gmail -dot- com>wrote:

> On Wed, May 13, 2009 at 12:08 PM, That Darned Writer
> <j_grey -at- writeangles -dot- com> wrote:
> > Have you provided your team with guidelines on creating documentation
> bugs?
>
> That's part of what I'm trying to write today.
>
> I'm somewhat new at this job (been here about 6 months) and I've
> inherited some less than helpful issues, some of which have been
> floating around in the system for so long that the people who entered
> them are no longer with the company. So far my team has been
> fabulously helpful. *loves my team* But while it seems like
> development and QA have a good handle on how to use issue tracking,
> it's the folks in the field (sales engineers, support) who have the
> most valuable input (actual *customer* contact) and the most trouble
> writing good issues. I'm trying to figure out how best to coach them
> towards providing me with useful input. Especially since we just
> hired a few new sales folk, and I anticipate feedback as they read
> through the docs to get up to speed on the product.
>
> It's not that I'm new to using issue tracking (been using bug tracking
> systems for 9 years now). This is just the first time that I've been
> in a position (lone writer) to tell the rest of the company how I'd
> like them to use it for doc issues.
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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.
> http://www.doctohelp.com
>
> 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!
> http://www.helpandmanual.com/
>
> ---
> You are currently subscribed to TECHWR-L as beelia -at- pacbell -dot- net -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
> http://lists.techwr-l.com/mailman/options/techwr-l/beelia%40pacbell.net
>
>
> 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
> http://www.techwr-l.com/ for more resources and info.
>
> Please move off-topic discussions to the Chat list, at:
> http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.
http://www.doctohelp.com

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! http://www.helpandmanual.com/

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Bug tracking and documentation: From: Julie Stickler
Re: Bug tracking and documentation: From: That Darned Writer
Re: Bug tracking and documentation: From: Julie Stickler

Previous by Author: Re: Amazing what you can do with paper prototypes
Next by Author: Re: Shazam! You're a marketing writer!
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